aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/pal.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/include/pal.h')
-rw-r--r--os/hal/include/pal.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/os/hal/include/pal.h b/os/hal/include/pal.h
index 2530471eb..8e66eb522 100644
--- a/os/hal/include/pal.h
+++ b/os/hal/include/pal.h
@@ -189,6 +189,8 @@ typedef struct {
* @param[in] config pointer to an architecture specific configuration
* structure. This structure is defined in the low level driver
* header.
+ *
+ * @init
*/
#define palInit(config) pal_lld_init(config)
@@ -199,6 +201,8 @@ typedef struct {
*
* @param[in] port port identifier
* @return The port logical states.
+ *
+ * @api
*/
#if !defined(pal_lld_readport) || defined(__DOXYGEN__)
#define palReadPort(port) ((void)(port), 0)
@@ -215,6 +219,8 @@ typedef struct {
*
* @param[in] port port identifier
* @return The latched logical states.
+ *
+ * @api
*/
#if !defined(pal_lld_readlatch) || defined(__DOXYGEN__)
#define palReadLatch(port) ((void)(port), 0)
@@ -229,6 +235,8 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] bits bits to be written on the specified port
+ *
+ * @api
*/
#if !defined(pal_lld_writeport) || defined(__DOXYGEN__)
#define palWritePort(port, bits) ((void)(port), (void)(bits))
@@ -248,6 +256,8 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] bits bits to be ORed on the specified port
+ *
+ * @api
*/
#if !defined(pal_lld_setport) || defined(__DOXYGEN__)
#define palSetPort(port, bits) { \
@@ -270,6 +280,7 @@ typedef struct {
* @param[in] port port identifier
* @param[in] bits bits to be cleared on the specified port
*
+ * @api
*/
#if !defined(pal_lld_clearport) || defined(__DOXYGEN__)
#define palClearPort(port, bits) { \
@@ -291,6 +302,8 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] bits bits to be XORed on the specified port
+ *
+ * @api
*/
#if !defined(pal_lld_toggleport) || defined(__DOXYGEN__)
#define palTogglePort(port, bits) { \
@@ -308,6 +321,8 @@ typedef struct {
* data
* @param[in] offset group bit offset within the port
* @return The group logical states.
+ *
+ * @api
*/
#if !defined(pal_lld_readgroup) || defined(__DOXYGEN__)
#define palReadGroup(port, mask, offset) \
@@ -325,6 +340,8 @@ typedef struct {
* @param[in] offset group bit offset within the port
* @param[in] bits bits to be written. Values exceeding the group
* width are masked.
+ *
+ * @api
*/
#if !defined(pal_lld_writegroup) || defined(__DOXYGEN__)
#define palWriteGroup(port, mask, offset, bits) { \
@@ -347,6 +364,7 @@ typedef struct {
* @param[in] mask group mask
* @param[in] mode group mode
*
+ * @api
*/
#if !defined(pal_lld_setgroupmode) || defined(__DOXYGEN__)
#define palSetGroupMode(port, mask, mode)
@@ -367,6 +385,7 @@ typedef struct {
* @retval PAL_LOW low logical state.
* @retval PAL_HIGH high logical state.
*
+ * @api
*/
#if !defined(pal_lld_readpad) || defined(__DOXYGEN__)
#define palReadPad(port, pad) ((palReadPort(port) >> (pad)) & 1)
@@ -390,6 +409,8 @@ typedef struct {
* @param[in] pad pad number within the port
* @param[in] bit logical value, the value must be @p PAL_LOW or
* @p PAL_HIGH
+ *
+ * @api
*/
#if !defined(pal_lld_writepad) || defined(__DOXYGEN__)
#define palWritePad(port, pad, bit) { \
@@ -413,6 +434,8 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ *
+ * @api
*/
#if !defined(pal_lld_setpad) || defined(__DOXYGEN__)
#define palSetPad(port, pad) palSetPort(port, PAL_PORT_BIT(pad))
@@ -433,6 +456,8 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ *
+ * @api
*/
#if !defined(pal_lld_clearpad) || defined(__DOXYGEN__)
#define palClearPad(port, pad) palClearPort(port, PAL_PORT_BIT(pad))
@@ -453,6 +478,8 @@ typedef struct {
*
* @param[in] port port identifier
* @param[in] pad pad number within the port
+ *
+ * @api
*/
#if !defined(pal_lld_togglepad) || defined(__DOXYGEN__)
#define palTogglePad(port, pad) palTogglePort(port, PAL_PORT_BIT(pad))
@@ -472,6 +499,8 @@ typedef struct {
* @param[in] port port identifier
* @param[in] pad pad number within the port
* @param[in] mode pad mode
+ *
+ * @api
*/
#if !defined(pal_lld_setpadmode) || defined(__DOXYGEN__)
#define palSetPadMode(port, pad, mode) \