private/hsb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed comments

Browse Source 
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@409 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
mmi
2017-12-18 14:32:51 +00:00
parent e92304755c
commit 0fb4fa7deb
11 changed files with 451 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/HAL/inc/CachedStorage.h
View File

@@ -1,6 +1,6 @@
// -----------------------------------------------------------------------------
/// @file CachedStorage.h
/// @brief EEPROM driver including local caching (for one page)
/// @brief Generic memory cache
// -----------------------------------------------------------------------------
// Micro-Key bv
// Industrieweg 28, 9804 TG Noordhorn
@@ -20,7 +20,7 @@
/// @defgroup {group_name} {group_description}
/// Description
/// @file adc.h
/// @file CachedStorage.h
/// @ingroup {group_name}
#ifndef _CACHEDEEPROM_H_
@@ -65,40 +65,135 @@ struct CachedStorage
// -----------------------------------------------------------------------------
/**
* Initializes the EEPROM hardware and reads the flash page
*/
/** ----------------------------------------------------------------------------
* CachedStorage_construct
* Constructor for a new cached storage instance
* Function makes use of MALLOC
*
* @param self The cache instance
* @param memoryDevice The memory device to use on which the
* cache is located
* @param pageNumber The pageNumber of the memory section on
* which the cache is located.
* This is usually for FLASH or EEPROM
* devices and required for PAGE-ERASE
* functionality. Can be set to any random
* value if PAGE-ERASE is not necessary
* @param cacheSize The size of the cache.
* This value is 32bit oriented and
* NOT BYTE-WISE.
* The memory allocation will internally
* re-calculate to bytes
*
* @return ErrorStatus SUCCESS if constructor was successful
* ERROR otherwise
*
* @todo
* -----------------------------------------------------------------------------
*/
ErrorStatus CachedStorage_construct(struct CachedStorage* self, struct MemoryDevice* memoryDevice, unsigned int pageNumber, size_t cacheSize);
/**
* Terminates the EEPROM hardware. SPI port is available again
*/
/** ----------------------------------------------------------------------------
* CachedStorage_destruct
* Destructor for a cached storage instance
* Function makes use of FREE
*
* @param self The cache instance to destruct
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
void CachedStorage_destruct(struct CachedStorage* self);
/**
* Writes four bytes to the storage buffer
*/
/** ----------------------------------------------------------------------------
* CachedStorage_writeWord
* Function to write a word (32bit) to cache
*
* @param self The cache instance
* @param offset Offset within the cache to put the data
* @param value The value/data to write
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
void CachedStorage_writeWord(struct CachedStorage* self, int offset, uint32_t value);
/**
* Writes binary data to the storage buffer
*/
/** ----------------------------------------------------------------------------
* CachedStorage_writeBlob
* Function to write a blob (any given format/amount of data) to cache; hence
* the void pointer.
* The function verifies cache boundaries using the offset and blob size
* blobsize is 32bit oriented, NOT BYTE
*
* @param self The cache instance
* @param offset Offset within the cache to put the data
* @param blob Void pointer to the data to be written
* @param blobSize sizeof the blob structure. Give in 32bit,
* NOT IN BYTES
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
void CachedStorage_writeBlob(struct CachedStorage* self, int offset, const void* blob, size_t blobSize);
/**
* Reads four bytes from the storage buffer
*/
/** ----------------------------------------------------------------------------
* CachedStorage_readWord
* Function to read a word (32bit) from cache
*
* @param self The cache instance
* @param offset Offset within the cache to put the data
*
* @return uint32_t The read data
*
* @todo
* -----------------------------------------------------------------------------
*/
uint32_t CachedStorage_readWord(struct CachedStorage* self, int offset);
/**
* Reads binary data from the storage buffer
*/
/** ----------------------------------------------------------------------------
* CachedStorage_readBlob
* Function to read a blob (any given format/amount of data) from cache; hence
* the void pointer.
* The function verifies cache boundaries using the offset
*
* @param self The cache instance
* @param offset Offset within the cache to put the data
*
* @return void* Void pointer to the blob structure
*
* @todo
* -----------------------------------------------------------------------------
*/
const void* CachedStorage_readBlob(struct CachedStorage* self, int offset);
/**
* Writes the storage buffer to EEPROM (only if the contents differ)
*/
/** ----------------------------------------------------------------------------
* CachedStorage_commit
* Function that puts the data from cache to the memory device.
* This function will verify that the content of the cache is actually different
* from the conent of the memory location. If data is equal, not write action
* will be performed
* In case of memory that needs PAGE-ERASE prior to write, the erase function
* will be called automatically.
*
* @param self The cache instance
*
* @return void
*
* @todo
* -----------------------------------------------------------------------------
*/
void CachedStorage_commit(struct CachedStorage* self);
#endif