938d17576b
This commit fixes nearly all of the reported doxygen warnings. I tried to not clutter the log with removed trailing spaces. Removed whitespace and converted tab/spaces for all files affected by this commit are in a separate branch.
176 lines
6.5 KiB
C
176 lines
6.5 KiB
C
/** \file cpu/stm32w108/hal/micro/cortexm3/mfg-token.h
|
|
* \brief Cortex-M3 Manufacturing token system
|
|
*
|
|
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
|
|
*/
|
|
|
|
#ifndef MFG_TOKEN_H_
|
|
#define MFG_TOKEN_H_
|
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
// The manufacturing tokens live in the Info Blocks, while all other tokens
|
|
// live in the Simulated EEPROM. This requires the token names to be defined
|
|
// as different data (mfg tokens are memory address, all others are an enum).
|
|
|
|
|
|
#define DEFINETOKENS
|
|
|
|
/**
|
|
* \brief Macro for translating token defs into address variables
|
|
* that point to the correct location in the Info Blocks. (This is the
|
|
* extern, the actual definition is found in hal/micro/cortexm3/token.c)
|
|
*
|
|
* \param name: The name of the token.
|
|
* \param creator: The manufacturing creators.
|
|
* \param iscnt:
|
|
* \param isidx:
|
|
* \param type: The token type. The types are found in token-stack.h.
|
|
* \param arraysize: The number of elements in an indexed token (arraysize=1
|
|
* for scalar tokens).
|
|
*/
|
|
#define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
|
|
extern const uint16_t TOKEN_##name;
|
|
#include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
|
|
#undef TOKEN_MFG
|
|
|
|
/**
|
|
* \brief Macro for translating token definitions into size variables.
|
|
* This provides a convenience for abstracting the 'sizeof(type)' anywhere.
|
|
*
|
|
* \param name: The name of the token.
|
|
* \param creator: The manufacturing creators.
|
|
* \param iscnt:
|
|
* \param isidx:
|
|
* \param type: The token type. The types are found in token-stack.h.
|
|
* \param arraysize: The number of elements in an indexed token (arraysize=1
|
|
* for scalar tokens).
|
|
*/
|
|
#define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
|
|
TOKEN_##name##_SIZE = sizeof(type),
|
|
enum {
|
|
#include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
|
|
};
|
|
#undef TOKEN_MFG
|
|
#undef TOKEN_DEF
|
|
|
|
/**
|
|
* \brief Macro for typedef'ing the CamelCase token type found in
|
|
* token-stack.h to a capitalized TOKEN style name that ends in _TYPE.
|
|
* This macro allows other macros below to use 'token\#\#_TYPE' to declare
|
|
* a local copy of that token.
|
|
*
|
|
* \param name: The name of the token.
|
|
* \param creator: The manufacturing creators.
|
|
* \param iscnt:
|
|
* \param isidx:
|
|
* \param type: The token type. The types are found in token-stack.h.
|
|
* \param arraysize: The number of elements in an indexed token (arraysize=1
|
|
* for scalar tokens).
|
|
*/
|
|
#define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
|
|
typedef type TOKEN_##name##_TYPE;
|
|
#include "cpu/stm32w108/hal/micro/cortexm3/token-manufacturing.h"
|
|
#undef TOKEN_MFG
|
|
|
|
#undef TOKEN_NEXT_ADDRESS
|
|
|
|
#define DEFINEADDRESSES
|
|
/**
|
|
* \brief Macro for creating a 'region' element in the enum below. This
|
|
* creates an element in the enum that provides a starting point (address) for
|
|
* subsequent tokens to align against. ( See hal/micro/cortexm3/token.c for
|
|
* the instances of TOKEN_NEXT_ADDRESS() );
|
|
*
|
|
* \param region: The name to give to the element in the address enum.
|
|
* \param address: The address in EEPROM where the region begins.
|
|
*/
|
|
#define TOKEN_NEXT_ADDRESS(region, address) \
|
|
TOKEN_##region##_NEXT_ADDRESS = ((address) - 1),
|
|
|
|
/**
|
|
* \brief Macro for creating ADDRESS and END elements for each token in
|
|
* the enum below. The ADDRESS element is linked to from the the normal
|
|
* TOKEN_\#\#name macro and provides the value passed into the internal token
|
|
* system calls. The END element is a placeholder providing the starting
|
|
* point for the ADDRESS of the next dynamically positioned token.
|
|
*
|
|
* \param name: The name of the token.
|
|
* \param creator: The manufacturing creators.
|
|
* \param iscnt:
|
|
* \param isidx:
|
|
* \param type: The token type. The types are found in token-stack.h.
|
|
* \param arraysize: The number of elements in an indexed token (arraysize=1
|
|
* for scalar tokens).
|
|
*/
|
|
#define TOKEN_MFG(name,creator,iscnt,isidx,type,arraysize,...) \
|
|
TOKEN_##name##_ADDRESS, \
|
|
TOKEN_##name##_END = TOKEN_##name##_ADDRESS + \
|
|
(TOKEN_##name##_SIZE * arraysize) - 1,
|
|
|
|
/**
|
|
* \brief The enum that operates on the two macros above. Also provides
|
|
* an indentifier so the address of the top of the token system can be known.
|
|
*/
|
|
enum {
|
|
#include "hal/micro/cortexm3/token-manufacturing.h"
|
|
};
|
|
#undef TOKEN_MFG
|
|
#undef DEFINEADDRESSES
|
|
|
|
#undef DEFINETOKENS
|
|
|
|
/**
|
|
* \brief Copies the token value from non-volatile storage into a RAM
|
|
* location. This is the internal function that the exposed API
|
|
* (halCommonGetMfgToken) expands out to. The
|
|
* API simplifies the access into this function by hiding the size parameter.
|
|
*
|
|
* \param data: A pointer to where the data being read should be placed.
|
|
*
|
|
* \param token: The name of the token to get data from. On this platform
|
|
* that name is defined as an address.
|
|
*
|
|
* \param index: The index to access. If the token being accessed is not an
|
|
* indexed token, this parameter is set by the API to be 0x7F.
|
|
*
|
|
* \param len: The length of the token being worked on. This value is
|
|
* automatically set by the API to be the size of the token.
|
|
*/
|
|
void halInternalGetMfgTokenData(void *data, uint16_t token, uint8_t index, uint8_t len);
|
|
|
|
/**
|
|
* \brief Sets the value of a token in non-volatile storage. This is
|
|
* the internal function that the exposed API (halCommonSetMfgToken)
|
|
* expands out to. The API simplifies the access into this function
|
|
* by hiding the size parameter.
|
|
*
|
|
* <b>NOTE:</b> CIB manufacturing tokens can only be written by on-chip
|
|
* code if the token is currently unprogrammed.
|
|
*
|
|
* <b>REMEMBER:</b> The flash hardware requires writing to 16bit aligned
|
|
* addresses with a length that is multiples of 16bits.
|
|
*
|
|
* \param token: The name of the token to get data from. On this platform
|
|
* that name is defined as an address.
|
|
*
|
|
* \param data: A pointer to the data being written.
|
|
*
|
|
* \param len: The length of the token being worked on. This value is
|
|
* automatically set by the API to be the size of the token.
|
|
*/
|
|
void halInternalSetMfgTokenData(uint16_t token, void *data, uint8_t len);
|
|
|
|
#define halCommonGetMfgToken( data, token ) \
|
|
halInternalGetMfgTokenData(data, token, 0x7F, token##_SIZE)
|
|
|
|
#define halCommonGetIndexedMfgToken( data, token, index ) \
|
|
halInternalGetMfgTokenData(data, token, index, token##_SIZE)
|
|
|
|
#define halCommonSetMfgToken( token, data ) \
|
|
halInternalSetMfgTokenData(token, data, token##_SIZE)
|
|
|
|
#endif //DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
#endif //MFG_TOKEN_H_
|