diff --git a/include/atomic.h b/include/atomic.h index 968a2e4cee9..986e89cc4da 100644 --- a/include/atomic.h +++ b/include/atomic.h @@ -61,7 +61,7 @@ extern int atomic_cas(atomic_t *target, #define ATOMIC_MASK(bit) (1 << ((bit) & (ATOMIC_BITS - 1))) #define ATOMIC_ELEM(addr, bit) ((addr) + ((bit) / ATOMIC_BITS)) -/*! @brief Test whether a bit is set +/** @brief Test whether a bit is set * * Test whether bit number bit is set or not. * @@ -81,7 +81,7 @@ static inline int atomic_test_bit(const atomic_t *addr, int bit) return (1 & (val >> (bit & (ATOMIC_BITS - 1)))); } -/*! @brief Clear a bit and return its old value +/** @brief Clear a bit and return its old value * * Atomically clear a bit and return its old value. * @@ -104,7 +104,7 @@ static inline int atomic_test_and_clear_bit(atomic_t *addr, int bit) return (old & mask) != 0; } -/*! @brief Set a bit and return its old value +/** @brief Set a bit and return its old value * * Atomically set a bit and return its old value. * @@ -127,7 +127,7 @@ static inline int atomic_test_and_set_bit(atomic_t *addr, int bit) return (old & mask) != 0; } -/*! @brief Clear a bit +/** @brief Clear a bit * * Atomically clear a bit. * @@ -145,7 +145,7 @@ static inline void atomic_clear_bit(atomic_t *addr, int bit) atomic_and(ATOMIC_ELEM(addr, bit), ~mask); } -/*! @brief Set a bit +/** @brief Set a bit * * Atomically set a bit. * diff --git a/include/bluetooth/bluetooth.h b/include/bluetooth/bluetooth.h index fa1a44de62a..075836865f5 100644 --- a/include/bluetooth/bluetooth.h +++ b/include/bluetooth/bluetooth.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Bluetooth subsystem core APIs. */ @@ -58,7 +58,7 @@ struct bt_eir { uint8_t data[29]; } __packed; -/*! @brief Define a type allowing user to implement a function that can +/** @brief Define a type allowing user to implement a function that can * be used to get back active LE scan results. * * A function of this type will be called back when user application @@ -76,7 +76,7 @@ typedef void bt_le_scan_cb_t(const bt_addr_le_t *addr, int8_t rssi, uint8_t adv_type, const uint8_t *adv_data, uint8_t len); -/*! @brief Start advertising +/** @brief Start advertising * * Set advertisement data, scan response data, advertisement parameters * and start advertising. @@ -90,7 +90,7 @@ typedef void bt_le_scan_cb_t(const bt_addr_le_t *addr, int8_t rssi, int bt_start_advertising(uint8_t type, const struct bt_eir *ad, const struct bt_eir *sd); -/*! @brief Start (LE) scanning +/** @brief Start (LE) scanning * * Start LE scanning with and provide results through the specified * callback. @@ -102,7 +102,7 @@ int bt_start_advertising(uint8_t type, const struct bt_eir *ad, */ int bt_start_scanning(uint8_t filter_dups, bt_le_scan_cb_t cb); -/*! @brief Stop (LE) scanning. +/** @brief Stop (LE) scanning. * * Stops ongoing LE scanning. * @@ -110,7 +110,7 @@ int bt_start_scanning(uint8_t filter_dups, bt_le_scan_cb_t cb); */ int bt_stop_scanning(void); -/*! @brief Initiate an LE connection to a remote device. +/** @brief Initiate an LE connection to a remote device. * * Allows initiate new LE link to remote peer using its address. * Returns a new reference that the the caller is responsible for managing. @@ -121,7 +121,7 @@ int bt_stop_scanning(void); */ struct bt_conn *bt_connect_le(const bt_addr_le_t *peer); -/*! @brief Disconnect from a remote device or cancel pending connection. +/** @brief Disconnect from a remote device or cancel pending connection. * * Disconnect an active connection with the specified reason code or cancel * pending outgoing connection. @@ -133,17 +133,17 @@ struct bt_conn *bt_connect_le(const bt_addr_le_t *peer); */ int bt_disconnect(struct bt_conn *conn, uint8_t reason); -/*! Security level. */ +/** Security level. */ typedef enum { - BT_SECURITY_LOW, /*! No encryption and no authentication. */ - BT_SECURITY_MEDIUM, /*! encryption and no authentication (no MITM). */ - BT_SECURITY_HIGH, /*! encryption and authentication (MITM). */ - BT_SECURITY_FIPS, /*! Authenticated LE Secure Connections and + BT_SECURITY_LOW, /** No encryption and no authentication. */ + BT_SECURITY_MEDIUM, /** encryption and no authentication (no MITM). */ + BT_SECURITY_HIGH, /** encryption and authentication (MITM). */ + BT_SECURITY_FIPS, /** Authenticated LE Secure Connections and * encryption. */ } bt_security_t; -/*! @brief Set security level for a connection. +/** @brief Set security level for a connection. * * This function enable security (encryption) for a connection. If device is * already paired with sufficiently strong key encryption will be enabled. If @@ -165,7 +165,7 @@ typedef enum { */ int bt_security(struct bt_conn *conn, bt_security_t sec); -/*! @def BT_ADDR_STR_LEN +/** @def BT_ADDR_STR_LEN * * @brief Recommended length of user string buffer for Bluetooth address * @@ -175,7 +175,7 @@ int bt_security(struct bt_conn *conn, bt_security_t sec); */ #define BT_ADDR_STR_LEN 18 -/*! @def BT_ADDR_LE_STR_LEN +/** @def BT_ADDR_LE_STR_LEN * * @brief Recommended length of user string buffer for Bluetooth LE address * @@ -185,7 +185,7 @@ int bt_security(struct bt_conn *conn, bt_security_t sec); */ #define BT_ADDR_LE_STR_LEN 27 -/*! @brief Converts binary Bluetooth address to string. +/** @brief Converts binary Bluetooth address to string. * * @param addr Address of buffer containing binary Bluetooth address. * @param str Address of user buffer with enough room to store formatted @@ -202,7 +202,7 @@ static inline int bt_addr_to_str(const bt_addr_t *addr, char *str, size_t len) addr->val[2], addr->val[1], addr->val[0]); } -/*! @brief Converts binary LE Bluetooth address to string. +/** @brief Converts binary LE Bluetooth address to string. * * @param addr Address of buffer containing binary LE Bluetooth address. * @param user_buf Address of user buffer with enough room to store diff --git a/include/bluetooth/buf.h b/include/bluetooth/buf.h index 07335e91760..86f01c8bc8c 100644 --- a/include/bluetooth/buf.h +++ b/include/bluetooth/buf.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Bluetooth buffer management. */ @@ -37,7 +37,7 @@ #include #include -/*! @def BT_BUF_MAX_DATA +/** @def BT_BUF_MAX_DATA * @brief Maximum amount of data that can fit in a buffer. * * The biggest foreseeable buffer size requirement right now comes from @@ -48,34 +48,34 @@ */ #define BT_BUF_MAX_DATA 74 -/*! Type of data contained in a buffer */ +/** Type of data contained in a buffer */ enum bt_buf_type { - BT_CMD, /*! HCI command */ - BT_EVT, /*! HCI event */ - BT_ACL_OUT, /*! Outgoing ACL data */ - BT_ACL_IN, /*! Incoming ACL data */ - BT_DUMMY = BT_CMD, /*! Only used for waking up fibers */ + BT_CMD, /** HCI command */ + BT_EVT, /** HCI event */ + BT_ACL_OUT, /** Outgoing ACL data */ + BT_ACL_IN, /** Incoming ACL data */ + BT_DUMMY = BT_CMD, /** Only used for waking up fibers */ }; -/*! HCI command specific information */ +/** HCI command specific information */ struct bt_buf_hci_data { - /*! Used by bt_hci_cmd_send_sync. Initially contains the waiting + /** Used by bt_hci_cmd_send_sync. Initially contains the waiting * semaphore, as the semaphore is given back contains the bt_buf * for the return parameters. */ void *sync; - /*! The command OpCode that the buffer contains */ + /** The command OpCode that the buffer contains */ uint16_t opcode; }; -/*! ACL data buffer specific information */ +/** ACL data buffer specific information */ struct bt_buf_acl_data { uint16_t handle; }; struct bt_buf { - /*! FIFO uses first 4 bytes itself, reserve space */ + /** FIFO uses first 4 bytes itself, reserve space */ int __unused; union { @@ -83,20 +83,20 @@ struct bt_buf { struct bt_buf_acl_data acl; }; - /*! Pointer to the start of data in the buffer. */ + /** Pointer to the start of data in the buffer. */ uint8_t *data; - /*! Length of the data behind the data pointer. */ + /** Length of the data behind the data pointer. */ uint8_t len; - uint8_t ref:5, /*! Reference count */ - type:3; /*! Type of data contained in the buffer */ + uint8_t ref:5, /** Reference count */ + type:3; /** Type of data contained in the buffer */ - /*! The full available buffer. */ + /** The full available buffer. */ uint8_t buf[BT_BUF_MAX_DATA]; }; -/*! @brief Get a new buffer from the pool. +/** @brief Get a new buffer from the pool. * * Get buffer from the available buffers pool with specified type and * reserved headroom. @@ -112,7 +112,7 @@ struct bt_buf { */ struct bt_buf *bt_buf_get(enum bt_buf_type type, size_t reserve_head); -/*! @brief Decrements the reference count of a buffer. +/** @brief Decrements the reference count of a buffer. * * Decrements the reference count of a buffer and puts it back into the * pool if the count reaches zero. @@ -121,7 +121,7 @@ struct bt_buf *bt_buf_get(enum bt_buf_type type, size_t reserve_head); */ void bt_buf_put(struct bt_buf *buf); -/*! Increment the reference count of a buffer. +/** Increment the reference count of a buffer. * * Increment the reference count of a buffer. * @@ -129,7 +129,7 @@ void bt_buf_put(struct bt_buf *buf); */ struct bt_buf *bt_buf_hold(struct bt_buf *buf); -/*! @brief Prepare data to be added at the end of the buffer +/** @brief Prepare data to be added at the end of the buffer * * Increments the data length of a buffer to account for more data * at the end. @@ -141,7 +141,7 @@ struct bt_buf *bt_buf_hold(struct bt_buf *buf); */ void *bt_buf_add(struct bt_buf *buf, size_t len); -/*! @brief Push data to the beginning of the buffer. +/** @brief Push data to the beginning of the buffer. * * Modifies the data pointer and buffer length to account for more data * in the beginning of the buffer. @@ -153,7 +153,7 @@ void *bt_buf_add(struct bt_buf *buf, size_t len); */ void *bt_buf_push(struct bt_buf *buf, size_t len); -/*! @brief Remove data from the beginning of the buffer. +/** @brief Remove data from the beginning of the buffer. * * Removes data from the beginnig of the buffer by modifying the data * pointer and buffer length. @@ -165,7 +165,7 @@ void *bt_buf_push(struct bt_buf *buf, size_t len); */ void *bt_buf_pull(struct bt_buf *buf, size_t len); -/*! @brief Remove and convert 16 bits from the beginning of the buffer. +/** @brief Remove and convert 16 bits from the beginning of the buffer. * * Same idea as with bt_buf_pull(), but a helper for operating on * 16-bit little endian data. @@ -176,7 +176,7 @@ void *bt_buf_pull(struct bt_buf *buf, size_t len); */ uint16_t bt_buf_pull_le16(struct bt_buf *buf); -/*! @brief Check buffer tailroom. +/** @brief Check buffer tailroom. * * Check how much free space there is at the end of the buffer. * @@ -184,7 +184,7 @@ uint16_t bt_buf_pull_le16(struct bt_buf *buf); */ size_t bt_buf_tailroom(struct bt_buf *buf); -/*! @brief Check buffer headroom. +/** @brief Check buffer headroom. * * Check how much free space there is in the beginning of the buffer. * @@ -192,7 +192,7 @@ size_t bt_buf_tailroom(struct bt_buf *buf); */ size_t bt_buf_headroom(struct bt_buf *buf); -/*! @def bt_buf_tail +/** @def bt_buf_tail * @brief Get the tail pointer for a buffer. * * Get a pointer to the end of the data in a buffer. @@ -203,7 +203,7 @@ size_t bt_buf_headroom(struct bt_buf *buf); */ #define bt_buf_tail(buf) ((buf)->data + (buf)->len) -/*! @brief Initialize buffer handling. +/** @brief Initialize buffer handling. * * Initialize the buffers with specified amount of incoming and outgoing * ACL buffers. The HCI command and event buffers will be allocated from diff --git a/include/bluetooth/conn.h b/include/bluetooth/conn.h index 17045479620..8a617f63ed4 100644 --- a/include/bluetooth/conn.h +++ b/include/bluetooth/conn.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Bluetooth connection handling */ @@ -36,10 +36,10 @@ #include -/*! Opaque type representing a connection to a remote device */ +/** Opaque type representing a connection to a remote device */ struct bt_conn; -/*! @brief Increment a connection's reference count. +/** @brief Increment a connection's reference count. * * Increment the reference count of a connection object. * @@ -49,7 +49,7 @@ struct bt_conn; */ struct bt_conn *bt_conn_get(struct bt_conn *conn); -/*! @brief Decrement a connection's reference count. +/** @brief Decrement a connection's reference count. * * Decrement the reference count of a connection object. * @@ -57,7 +57,7 @@ struct bt_conn *bt_conn_get(struct bt_conn *conn); */ void bt_conn_put(struct bt_conn *conn); -/*! @brief Look up an existing connection by address. +/** @brief Look up an existing connection by address. * * Look up an existing connection based on the remote address. * @@ -69,7 +69,7 @@ void bt_conn_put(struct bt_conn *conn); */ struct bt_conn *bt_conn_lookup_addr_le(const bt_addr_le_t *peer); -/*! @brief Get destination (peer) address of a connection. +/** @brief Get destination (peer) address of a connection. * * @param conn Connection object. * @@ -77,7 +77,7 @@ struct bt_conn *bt_conn_lookup_addr_le(const bt_addr_le_t *peer); */ const bt_addr_le_t *bt_conn_get_dst(const struct bt_conn *conn); -/*! Connection callback structure */ +/** Connection callback structure */ struct bt_conn_cb { void (*connected)(struct bt_conn *conn); void (*disconnected)(struct bt_conn *conn); @@ -85,7 +85,7 @@ struct bt_conn_cb { struct bt_conn_cb *_next; }; -/*! @brief Register connection callbacks. +/** @brief Register connection callbacks. * * Register callbacks to monitor the state of connections. * diff --git a/include/bluetooth/driver.h b/include/bluetooth/driver.h index c56b609277a..fcd0b9a2f13 100644 --- a/include/bluetooth/driver.h +++ b/include/bluetooth/driver.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Bluetooth HCI driver API. */ diff --git a/include/bluetooth/gatt.h b/include/bluetooth/gatt.h index 9a39b6354c9..c550247d2c8 100644 --- a/include/bluetooth/gatt.h +++ b/include/bluetooth/gatt.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Generic Attribute Profile handling. */ @@ -39,142 +39,142 @@ /* GATT attribute permission bitfield values */ -/*! @def BT_GATT_PERM_READ +/** @def BT_GATT_PERM_READ * @brief Attribute read permission. */ #define BT_GATT_PERM_READ 0x01 -/*! @def BT_GATT_PERM_WRITE +/** @def BT_GATT_PERM_WRITE * @brief Attribute write permission. */ #define BT_GATT_PERM_WRITE 0x02 -/*! @def BT_GATT_PERM_READ_ENCRYPT +/** @def BT_GATT_PERM_READ_ENCRYPT * @brief Attribute read permission with encryption. * * If set, requires encryption for read access. */ #define BT_GATT_PERM_READ_ENCRYPT 0x04 -/*! @def BT_GATT_PERM_WRITE_ENCRYPT +/** @def BT_GATT_PERM_WRITE_ENCRYPT * @brief Attribute write permission with encryption. * * If set, requires encryption for write access. */ #define BT_GATT_PERM_WRITE_ENCRYPT 0x08 -/*! @def BT_GATT_PERM_READ_AUTHEN +/** @def BT_GATT_PERM_READ_AUTHEN * @brief Attribute read permission with authentication. * * If set, requires encryption using authenticated link-key for read access. */ #define BT_GATT_PERM_READ_AUTHEN 0x10 -/*! @def BT_GATT_PERM_WRITE_AUTHEN +/** @def BT_GATT_PERM_WRITE_AUTHEN * @brief Attribute write permission with authentication. * * If set, requires encryption using authenticated link-key for write access. */ #define BT_GATT_PERM_WRITE_AUTHEN 0x20 -/*! @def BT_GATT_PERM_AUTHOR +/** @def BT_GATT_PERM_AUTHOR * @brief Attribute authorization permission. */ #define BT_GATT_PERM_AUTHOR 0x40 /* GATT attribute flush flags */ -/*! @def BT_GATT_FLUSH_DISCARD +/** @def BT_GATT_FLUSH_DISCARD * @brief Attribute flush discard flag. */ #define BT_GATT_FLUSH_DISCARD 0x00 -/*! @def BT_GATT_FLUSH_DISCARD +/** @def BT_GATT_FLUSH_DISCARD * @brief Attribute flush syncronize flag. */ #define BT_GATT_FLUSH_SYNC 0x01 -/*! @brief GATT Attribute structure. */ +/** @brief GATT Attribute structure. */ struct bt_gatt_attr { - /*! Attribute UUID */ + /** Attribute UUID */ const struct bt_uuid *uuid; - /*! Attribute read callback */ + /** Attribute read callback */ int (*read)(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t len, uint16_t offset); - /*! Attribute write callback */ + /** Attribute write callback */ int (*write)(struct bt_conn *conn, const struct bt_gatt_attr *attr, const void *buf, uint8_t len, uint16_t offset); - /*! Attribute flush callback */ + /** Attribute flush callback */ int (*flush)(struct bt_conn *conn, const struct bt_gatt_attr *attr, uint8_t flags); - /*! Attribute user data */ + /** Attribute user data */ void *user_data; - /*! Attribute handle */ + /** Attribute handle */ uint16_t handle; - /*! Attribute permissions */ + /** Attribute permissions */ uint8_t perm; }; -/*! @brief Service Attribute Value. */ +/** @brief Service Attribute Value. */ struct bt_gatt_service { - /*! Service UUID. */ + /** Service UUID. */ const struct bt_uuid *uuid; }; -/*! @brief Include Attribute Value. */ +/** @brief Include Attribute Value. */ struct bt_gatt_include { - /*! Service UUID. */ + /** Service UUID. */ const struct bt_uuid *uuid; - /*! Service start handle. */ + /** Service start handle. */ uint16_t start_handle; - /*! Service end handle. */ + /** Service end handle. */ uint16_t end_handle; }; /* Characteristic Properties Bitfield values */ -/*! @def BT_GATT_CHRC_BROADCAST +/** @def BT_GATT_CHRC_BROADCAST * @brief Characteristic broadcast property. * * If set, permits broadcasts of the Characteristic Value using Server * Characteristic Configuration Descriptor. */ #define BT_GATT_CHRC_BROADCAST 0x01 -/*! @def BT_GATT_CHRC_READ +/** @def BT_GATT_CHRC_READ * @brief Characteristic read property. * * If set, permits reads of the Characteristic Value. */ #define BT_GATT_CHRC_READ 0x02 -/*! @def BT_GATT_CHRC_WRITE_WITHOUT_RESP +/** @def BT_GATT_CHRC_WRITE_WITHOUT_RESP * @brief Characteristic write without response property. * * If set, permits write of the Characteristic Value without response. */ #define BT_GATT_CHRC_WRITE_WITHOUT_RESP 0x04 -/*! @def BT_GATT_CHRC_WRITE +/** @def BT_GATT_CHRC_WRITE * @brief Characteristic write with response property. * * If set, permits write of the Characteristic Value with response. */ #define BT_GATT_CHRC_WRITE 0x08 -/*! @def BT_GATT_CHRC_NOTIFY +/** @def BT_GATT_CHRC_NOTIFY * @brief Characteristic notify property. * * If set, permits notifications of a Characteristic Value without * acknowledgment. */ #define BT_GATT_CHRC_NOTIFY 0x10 -/*! @def BT_GATT_CHRC_INDICATE +/** @def BT_GATT_CHRC_INDICATE * @brief Characteristic indicate property. * * If set, permits indications of a Characteristic Value with acknowledgment. */ #define BT_GATT_CHRC_INDICATE 0x20 -/*! @def BT_GATT_CHRC_AUTH +/** @def BT_GATT_CHRC_AUTH * @brief Characteristic Authenticated Signed Writes property. * * If set, permits signed writes to the Characteristic Value. */ #define BT_GATT_CHRC_AUTH 0x40 -/*! @def BT_GATT_CHRC_EXT_PROP +/** @def BT_GATT_CHRC_EXT_PROP * @brief Characteristic Extended Properties property. * * If set, additional characteristic properties are defined in the @@ -182,13 +182,13 @@ struct bt_gatt_include { */ #define BT_GATT_CHRC_EXT_PROP 0x80 -/*! @brief Characteristic Attribute Value. */ +/** @brief Characteristic Attribute Value. */ struct bt_gatt_chrc { - /*! Characteristic UUID. */ + /** Characteristic UUID. */ const struct bt_uuid *uuid; - /*! Characteristic value handle. */ + /** Characteristic value handle. */ uint16_t value_handle; - /*! Characteristic properties. */ + /** Characteristic properties. */ uint8_t properties; }; @@ -196,27 +196,27 @@ struct bt_gatt_chrc { #define BT_GATT_CEP_RELIABLE_WRITE 0x0001 #define BT_GATT_CEP_WRITABLE_AUX 0x0002 -/*! @brief Characteristic Extended Properties Attribute Value. */ +/** @brief Characteristic Extended Properties Attribute Value. */ struct bt_gatt_cep { - /*! Characteristic Extended properties */ + /** Characteristic Extended properties */ uint16_t properties; }; -/*! @brief Characteristic User Description Attribute Value. */ +/** @brief Characteristic User Description Attribute Value. */ struct bt_gatt_cud { - /*! Characteristic User Description string. */ + /** Characteristic User Description string. */ char *string; }; /* Client Characteristic Configuration Values */ -/*! @def BT_GATT_CCC_NOTIFY +/** @def BT_GATT_CCC_NOTIFY * @brief Client Characteristic Configuration Notification. * * If set, changes to Characteristic Value shall be notified. */ #define BT_GATT_CCC_NOTIFY 0x0001 -/*! @def BT_GATT_CCC_INDICATE +/** @def BT_GATT_CCC_INDICATE * @brief Client Characteristic Configuration Indication. * * If set, changes to Characteristic Value shall be indicated. @@ -225,13 +225,13 @@ struct bt_gatt_cud { /* Client Characteristic Configuration Attribute Value */ struct bt_gatt_ccc { - /*! Client Characteristic Configuration flags */ + /** Client Characteristic Configuration flags */ uint16_t flags; }; /* Server API */ -/*! @brief Register attribute database. +/** @brief Register attribute database. * * Register GATT attribute database table. Applications can make use of * macros such as BT_GATT_PRIMARY_SERVICE, BT_GATT_CHARACTERISTIC, @@ -247,7 +247,7 @@ enum { BT_GATT_ITER_CONTINUE, }; -/*! @brief Attribute iterator callback. +/** @brief Attribute iterator callback. * * @param attr Attribute found. * @param user_data Data given. @@ -258,7 +258,7 @@ enum { typedef uint8_t (*bt_gatt_attr_func_t)(const struct bt_gatt_attr *attr, void *user_data); -/*! @brief Attribute iterator. +/** @brief Attribute iterator. * * Iterate attributes in the given range. * @@ -270,7 +270,7 @@ typedef uint8_t (*bt_gatt_attr_func_t)(const struct bt_gatt_attr *attr, void bt_gatt_foreach_attr(uint16_t start_handle, uint16_t end_handle, bt_gatt_attr_func_t func, void *user_data); -/*! @brief Generic Read Attribute value helper. +/** @brief Generic Read Attribute value helper. * * Read attribute value storing the result into buffer. * @@ -289,7 +289,7 @@ int bt_gatt_attr_read(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t buf_len, uint16_t offset, const void *value, uint8_t value_len); -/*! @brief Read Service Attribute helper. +/** @brief Read Service Attribute helper. * * Read service attribute value storing the result into buffer after * enconding it. @@ -308,7 +308,7 @@ int bt_gatt_attr_read_service(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t len, uint16_t offset); -/*! @def BT_GATT_SERVICE +/** @def BT_GATT_SERVICE * @brief Generic Service Declaration Macro. * * Helper macro to declare a service attribute. @@ -326,7 +326,7 @@ int bt_gatt_attr_read_service(struct bt_conn *conn, .user_data = _service, \ } -/*! @def BT_GATT_PRIMARY_SERVICE +/** @def BT_GATT_PRIMARY_SERVICE * @brief Primary Service Declaration Macro. * * Helper macro to declare a primary service attribute. @@ -344,7 +344,7 @@ int bt_gatt_attr_read_service(struct bt_conn *conn, .user_data = _service, \ } -/*! @def BT_GATT_SECONDARY_SERVICE +/** @def BT_GATT_SECONDARY_SERVICE * @brief Secondary Service Declaration Macro. * * Helper macro to declare a secondary service attribute. @@ -362,7 +362,7 @@ int bt_gatt_attr_read_service(struct bt_conn *conn, .user_data = _service, \ } -/*! @brief Read Include Attribute helper. +/** @brief Read Include Attribute helper. * * Read include service attribute value storing the result into buffer after * enconding it. @@ -381,7 +381,7 @@ int bt_gatt_attr_read_included(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t len, uint16_t offset); -/*! @def BT_GATT_INCLUDE_SERVICE +/** @def BT_GATT_INCLUDE_SERVICE * @brief Include Service Declaration Macro. * * Helper macro to declare a include service attribute. @@ -399,7 +399,7 @@ int bt_gatt_attr_read_included(struct bt_conn *conn, .user_data = _service, \ } -/*! @brief Read Characteristic Attribute helper. +/** @brief Read Characteristic Attribute helper. * * Read characteristic attribute value storing the result into buffer after * enconding it. @@ -418,7 +418,7 @@ int bt_gatt_attr_read_chrc(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t len, uint16_t offset); -/*! @def BT_GATT_CHARACTERISTIC +/** @def BT_GATT_CHARACTERISTIC * @brief Characteristic Declaration Macro. * * Helper macro to declare a characteristic attribute. @@ -436,13 +436,13 @@ int bt_gatt_attr_read_chrc(struct bt_conn *conn, .user_data = _value, \ } -/*! @brief GATT CCC configuration entry. */ +/** @brief GATT CCC configuration entry. */ struct bt_gatt_ccc_cfg { - /*! Config peer address. */ + /** Config peer address. */ bt_addr_le_t peer; - /*! Config peer value. */ + /** Config peer value. */ uint16_t value; - /*! Config valid flag. */ + /** Config valid flag. */ uint8_t valid; }; @@ -455,7 +455,7 @@ struct _bt_gatt_ccc { void (*cfg_changed)(uint16_t value); }; -/*! @brief Read Client Characteristic Configuration Attribute helper. +/** @brief Read Client Characteristic Configuration Attribute helper. * * Read CCC attribute value storing the result into buffer after * enconding it. @@ -474,7 +474,7 @@ int bt_gatt_attr_read_ccc(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t len, uint16_t offset); -/*! @brief Write Client Characteristic Configuration Attribute helper. +/** @brief Write Client Characteristic Configuration Attribute helper. * * Write value in the buffer into CCC attribute. * NOTE: Only use this with attributes which user_data is a _bt_gatt_ccc. @@ -492,7 +492,7 @@ int bt_gatt_attr_write_ccc(struct bt_conn *conn, const struct bt_gatt_attr *attr, const void *buf, uint8_t len, uint16_t offset); -/*! @def BT_GATT_CCC +/** @def BT_GATT_CCC * @brief Client Characteristic Configuration Declaration Macro. * * Helper macro to declare a CCC attribute. @@ -516,7 +516,7 @@ int bt_gatt_attr_write_ccc(struct bt_conn *conn, .cfg_changed = _cfg_changed, }),\ } -/*! @brief Read Characteristic Extended Properties Attribute helper +/** @brief Read Characteristic Extended Properties Attribute helper * * Read CEP attribute value storing the result into buffer after * enconding it. @@ -535,7 +535,7 @@ int bt_gatt_attr_read_cep(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint8_t len, uint16_t offset); -/*! @def BT_GATT_CEP +/** @def BT_GATT_CEP * @brief Characteristic Extended Properties Declaration Macro. * * Helper macro to declare a CEP attribute. @@ -553,7 +553,7 @@ int bt_gatt_attr_read_cep(struct bt_conn *conn, .user_data = _value, \ } -/*! @def BT_GATT_DESCRIPTOR +/** @def BT_GATT_DESCRIPTOR * @brief Descriptor Declaration Macro. * * Helper macro to declare a descriptor attribute. @@ -575,7 +575,7 @@ int bt_gatt_attr_read_cep(struct bt_conn *conn, .user_data = _value, \ } -/*! @def BT_GATT_LONG_DESCRIPTOR +/** @def BT_GATT_LONG_DESCRIPTOR * @brief Descriptor Declaration Macro. * * Helper macro to declare a descriptor attribute. @@ -600,7 +600,7 @@ int bt_gatt_attr_read_cep(struct bt_conn *conn, .user_data = _value, \ } -/*! @brief Notify attribute value change. +/** @brief Notify attribute value change. * * Send notification of attribute value change. * Note: This function should only be called if CCC is declared with @@ -612,13 +612,13 @@ int bt_gatt_attr_read_cep(struct bt_conn *conn, */ void bt_gatt_notify(uint16_t handle, const void *data, size_t len); -/*! @brief connected callback. +/** @brief connected callback. * * @param conn Connection object. */ void bt_gatt_connected(struct bt_conn *conn); -/*! @brief disconnected callback. +/** @brief disconnected callback. * * @param conn Connection object. */ diff --git a/include/bluetooth/log.h b/include/bluetooth/log.h index 33dd08cfa1f..de49b84a7db 100644 --- a/include/bluetooth/log.h +++ b/include/bluetooth/log.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Bluetooth subsystem logging helpers. */ diff --git a/include/bluetooth/uuid.h b/include/bluetooth/uuid.h index 531c1aee4b5..b8f5d83db46 100644 --- a/include/bluetooth/uuid.h +++ b/include/bluetooth/uuid.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Bluetooth UUID handling */ @@ -34,138 +34,138 @@ #ifndef __BT_UUID_H #define __BT_UUID_H -/*! @def BBT_UUID_GAP +/** @def BBT_UUID_GAP * @brief Generic Access */ #define BT_UUID_GAP 0x1800 -/*! @def BBT_UUID_GATT +/** @def BBT_UUID_GATT * @brief Generic Attribute */ #define BT_UUID_GATT 0x1801 -/*! @def BBT_UUID_CTS +/** @def BBT_UUID_CTS * @brief Current Time Service */ #define BT_UUID_CTS 0x1805 -/*! @def BBT_UUID_DIS +/** @def BBT_UUID_DIS * @brief Device Information Service */ #define BT_UUID_DIS 0x180a -/*! @def BBT_UUID_HRS +/** @def BBT_UUID_HRS * @brief Heart Rate Service */ #define BT_UUID_HRS 0x180d -/*! @def BBT_UUID_BAS +/** @def BBT_UUID_BAS * @brief Battery Service */ #define BT_UUID_BAS 0x180f -/*! @def BT_UUID_GATT_PRIMARY +/** @def BT_UUID_GATT_PRIMARY * @brief GATT Primary Service */ #define BT_UUID_GATT_PRIMARY 0x2800 -/*! @def BT_UUID_GATT_SECONDARY +/** @def BT_UUID_GATT_SECONDARY * @brief GATT Secondary Service */ #define BT_UUID_GATT_SECONDARY 0x2801 -/*! @def BT_UUID_GATT_INCLUDE +/** @def BT_UUID_GATT_INCLUDE * @brief GATT Include Service */ #define BT_UUID_GATT_INCLUDE 0x2802 -/*! @def BT_UUID_GATT_CHRC +/** @def BT_UUID_GATT_CHRC * @brief GATT Characteristic */ #define BT_UUID_GATT_CHRC 0x2803 -/*! @def BT_UUID_GATT_CEP +/** @def BT_UUID_GATT_CEP * @brief GATT Characteristic Extended Properties */ #define BT_UUID_GATT_CEP 0x2900 -/*! @def BT_UUID_GATT_CUD +/** @def BT_UUID_GATT_CUD * @brief GATT Characteristic User Description */ #define BT_UUID_GATT_CUD 0x2901 -/*! @def BT_UUID_GATT_CCC +/** @def BT_UUID_GATT_CCC * @brief GATT Client Characteristic Configuration */ #define BT_UUID_GATT_CCC 0x2902 -/*! @def BT_UUID_GAP_DEVICE_NAME +/** @def BT_UUID_GAP_DEVICE_NAME * @brief GAP Characteristic Device Name */ #define BT_UUID_GAP_DEVICE_NAME 0x2a00 -/*! @def BT_UUID_GAP_APPEARANCE +/** @def BT_UUID_GAP_APPEARANCE * @brief GAP Characteristic Appearance */ #define BT_UUID_GAP_APPEARANCE 0x2a01 -/*! @def BT_UUID_BAS_BATTERY_LEVEL +/** @def BT_UUID_BAS_BATTERY_LEVEL * @brief BAS Characteristic Battery Level */ #define BT_UUID_BAS_BATTERY_LEVEL 0x2a19 -/*! @def BT_UUID_DIS_SYSTEM_ID +/** @def BT_UUID_DIS_SYSTEM_ID * @brief DIS Characteristic System ID */ #define BT_UUID_DIS_SYSTEM_ID 0x2a23 -/*! @def BT_UUID_DIS_MODEL_NUMBER_STRING +/** @def BT_UUID_DIS_MODEL_NUMBER_STRING * @brief DIS Characteristic Model Number String */ #define BT_UUID_DIS_MODEL_NUMBER_STRING 0x2a24 -/*! @def BT_UUID_DIS_SERIAL_NUMBER_STRING +/** @def BT_UUID_DIS_SERIAL_NUMBER_STRING * @brief DIS Characteristic Serial Number String */ #define BT_UUID_DIS_SERIAL_NUMBER_STRING 0x2a25 -/*! @def BT_UUID_DIS_FIRMWARE_REVISION_STRING +/** @def BT_UUID_DIS_FIRMWARE_REVISION_STRING * @brief DIS Characteristic Firmware Revision String */ #define BT_UUID_DIS_FIRMWARE_REVISION_STRING 0x2a26 -/*! @def BT_UUID_DIS_HARDWARE_REVISION_STRING +/** @def BT_UUID_DIS_HARDWARE_REVISION_STRING * @brief DIS Characteristic Hardware Revision String */ #define BT_UUID_DIS_HARDWARE_REVISION_STRING 0x2a27 -/*! @def BT_UUID_DIS_SOFTWARE_REVISION_STRING +/** @def BT_UUID_DIS_SOFTWARE_REVISION_STRING * @brief DIS Characteristic Software Revision String */ #define BT_UUID_DIS_SOFTWARE_REVISION_STRING 0x2a28 -/*! @def BT_UUID_DIS_MANUFACTURER_NAME_STRING +/** @def BT_UUID_DIS_MANUFACTURER_NAME_STRING * @brief DIS Characteristic Manufacturer Name String */ #define BT_UUID_DIS_MANUFACTURER_NAME_STRING 0x2a29 -/*! @def BT_UUID_DIS_PNP_ID +/** @def BT_UUID_DIS_PNP_ID * @brief DIS Characteristic PnP ID */ #define BT_UUID_DIS_PNP_ID 0x2a50 -/*! @def BT_UUID_CTS_CURRENT_TIME +/** @def BT_UUID_CTS_CURRENT_TIME * @brief CTS Characteristic Current Time */ #define BT_UUID_CTS_CURRENT_TIME 0x2a2b -/*! @def BT_UUID_HR_MEASUREMENT +/** @def BT_UUID_HR_MEASUREMENT * @brief HRS Characteristic Measurement Interval */ #define BT_UUID_HRS_MEASUREMENT 0x2a37 -/*! @def BT_UUID_HRS_BODY_SENSOR +/** @def BT_UUID_HRS_BODY_SENSOR * @brief HRS Characteristic Body Sensor Location */ #define BT_UUID_HRS_BODY_SENSOR 0x2a38 -/*! @def BT_UUID_HR_CONTROL_POINT +/** @def BT_UUID_HR_CONTROL_POINT * @brief HRS Characteristic Control Point */ #define BT_UUID_HRS_CONTROL_POINT 0x2a39 -/*! @brief Bluetooth UUID types */ +/** @brief Bluetooth UUID types */ enum bt_uuid_type { BT_UUID_16, BT_UUID_128, }; -/*! @brief Bluetooth UUID structure */ +/** @brief Bluetooth UUID structure */ struct bt_uuid { - /*! UUID type */ + /** UUID type */ uint8_t type; union { - /*! UUID 16 bits value */ + /** UUID 16 bits value */ uint16_t u16; - /*! UUID 128 bits value */ + /** UUID 128 bits value */ uint8_t u128[16]; }; }; -/*! @brief Compare Bluetooth UUIDs. +/** @brief Compare Bluetooth UUIDs. * * Compares 2 Bluetooth UUIDs, if the types are different both UUIDs are * first converted to 128 bits format before comparing. diff --git a/include/device.h b/include/device.h index e3e5652128f..b8ca10c3daf 100644 --- a/include/device.h +++ b/include/device.h @@ -31,7 +31,7 @@ #ifndef _DEVICE_H_ #define _DEVICE_H_ -/*! @def DECLARE_DEVICE_INIT_CONFIG +/** @def DECLARE_DEVICE_INIT_CONFIG * * @brief Define an config object * @@ -62,24 +62,24 @@ struct device; /* Static device infomation (In ROM) Per driver instance */ struct device_config { - /*! name of the device */ + /** name of the device */ char *name; - /*! init function for the driver */ + /** init function for the driver */ int (*init)(struct device *device); - /*! address of driver instance config information */ + /** address of driver instance config information */ void *config_info; }; /* Runtime device structure (In memory) Per driver instance */ struct device { - /*! Build time config information */ + /** Build time config information */ struct device_config *config; - /*! pointer to structure containing the API functions for the + /** pointer to structure containing the API functions for the * device type. This pointer is filled in by the driver at * init time. */ void *driver_api; - /*! Driver instance data. For driver use only*/ + /** Driver instance data. For driver use only*/ void *driver_data; }; diff --git a/include/drivers/k20_watchdog.h b/include/drivers/k20_watchdog.h index 1d6e8110bc8..f625c9e4528 100644 --- a/include/drivers/k20_watchdog.h +++ b/include/drivers/k20_watchdog.h @@ -84,10 +84,10 @@ typedef volatile struct { } K20_WDOG_t; /***********************************************************************/ -/*!< Macro to enable all interrupts. */ +/**< Macro to enable all interrupts. */ #define EnableInterrupts __asm__(" CPSIE i"); -/*!< Macro to disable all interrupts. */ +/**< Macro to disable all interrupts. */ #define DisableInterrupts __asm__(" CPSID i"); /***********************************************************************/ diff --git a/include/drivers/simple/uart.h b/include/drivers/simple/uart.h index 0a670386f53..0d6b057fd09 100644 --- a/include/drivers/simple/uart.h +++ b/include/drivers/simple/uart.h @@ -1,4 +1,4 @@ -/*! @file +/** @file * @brief Simple UART driver header file. * * A simple UART driver that allows applications to handle all aspects of @@ -37,7 +37,7 @@ #include -/*! @brief Received data callback. +/** @brief Received data callback. * * This function is called when new data is received on UART. The off parameter * can be used to alter offset at which received data is stored. Typically, @@ -51,7 +51,7 @@ */ typedef uint8_t *(*uart_simple_recv_cb)(uint8_t *buf, size_t *off); -/*! @brief Register UART application. +/** @brief Register UART application. * * This function is used to register new UART application. * @@ -61,7 +61,7 @@ typedef uint8_t *(*uart_simple_recv_cb)(uint8_t *buf, size_t *off); */ void uart_simple_register(uint8_t *buf, size_t len, uart_simple_recv_cb cb); -/*! @brief Send data over UART. +/** @brief Send data over UART. * * This function is used to send data over UART. * @@ -72,7 +72,7 @@ void uart_simple_register(uint8_t *buf, size_t len, uart_simple_recv_cb cb); */ int uart_simple_send(const uint8_t *data, int len); -/*! @brief Simple UART interrupt handler. +/** @brief Simple UART interrupt handler. * * This function is called from an interrupt and should not be called by * an application directly. diff --git a/include/gpio.h b/include/gpio.h index 3bb62714511..c5cc677ce8c 100644 --- a/include/gpio.h +++ b/include/gpio.h @@ -91,7 +91,7 @@ struct gpio_driver_api { gpio_resume_port_t resume; }; -/*! +/** * @brief Configure a single pin * @param port Pointer to device structure for driver instance. * @param pin Pin number operate on. @@ -106,7 +106,7 @@ inline int gpio_pin_configure(struct device *port, uint8_t pin, return api->config(port, GPIO_ACCESS_BY_PIN, pin, flags); } -/*! +/** * @brief Write data value of a single pin. * @param port Pointer to device structure for driver instance. * @param pin Pin number operate on. @@ -121,7 +121,7 @@ inline int gpio_pin_write(struct device *port, uint32_t pin, uint32_t value) } -/*! +/** * @brief Read data value of a single pin. * @param port Pointer to device structure for driver instance. * @param pin Pin number operate on. @@ -136,7 +136,7 @@ inline int gpio_pin_read(struct device *port, uint32_t pin, uint32_t *value) } -/*! +/** * @brief Set the application callback.. * @param port Pointer to device structure for driver instance. * @param callback Application callback function. @@ -150,7 +150,7 @@ inline int gpio_set_callback(struct device *port, return api->set_callback(port, callback); } -/*! +/** * @brief Enable pin callback. * @param port Pointer to device structure for driver instance. * @param pin Pin number operate on. @@ -164,7 +164,7 @@ inline int gpio_pin_enable_callback(struct device *port, uint32_t pin) } -/*! +/** * @brief Disable pin callback. * @param port Pointer to device structure for driver instance. * @param pin Pin number operate on. @@ -178,7 +178,7 @@ inline int gpio_pin_disable_callback(struct device *port, uint32_t pin) } -/*! +/** * @brief Configure all pins in the port. * @param port Pointer to device structure for driver instance. * @param flags Flags for port configuration. IN/OUT, interrupt ... @@ -191,7 +191,7 @@ inline int gpio_port_configure(struct device *port, int flags) return api->config(port, GPIO_ACCESS_BY_PORT, 0, flags); } -/*! +/** * @brief Write data value to the port. * @param port Pointer to device structure for driver instance. * @param value Value to set the pin to. @@ -205,7 +205,7 @@ inline int gpio_port_write(struct device *port, uint32_t value) } -/*! +/** * @brief Read data value of the port. * @param port Pointer to device structure for driver instance. * @param value Integer pointer to receive the output of the read. @@ -219,7 +219,7 @@ inline int gpio_port_read(struct device *port, uint32_t *value) } -/*! +/** * @brief Enable port callback. * @param port Pointer to device structure for driver instance. */ @@ -232,7 +232,7 @@ inline int gpio_port_enable_callback(struct device *port) } -/*! +/** * @brief Disable port callback. * @param port Pointer to device structure for driver instance. */ @@ -244,7 +244,7 @@ inline int gpio_port_disable_callback(struct device *port) return api->disable_callback(port, GPIO_ACCESS_BY_PORT, 0); } -/*! +/** * @brief Save the state of the device and go to low power state * @param port Pointer to device structure for driver instance. */ @@ -256,7 +256,7 @@ inline int gpio_suspend(struct device *port) return api->suspend(port); } -/*! +/** * @brief Restore state stored during suspend and resume operation. * @param port Pointer to device structure for driver instance. */ diff --git a/include/i2c.h b/include/i2c.h index 0761f4e52fe..7abed4108f7 100644 --- a/include/i2c.h +++ b/include/i2c.h @@ -92,7 +92,7 @@ struct i2c_driver_api { i2c_api_resume resume; }; -/*! +/** * @brief Configure a host controllers operation * @param dev Pointer to the device structure for the driver instance * @param config Pointer to the application provided configuration @@ -105,7 +105,7 @@ inline int i2c_configure(struct device *dev, struct i2c_config *config) return api->configure(dev, config); } -/*! +/** * @brief Configure a host controllers operation * @param dev Pointer to the device structure for the driver instance * @param buf Memory pool that data should be transferred from @@ -119,7 +119,7 @@ inline int i2c_write(struct device *dev, unsigned char *buf, uint32_t len) return api->write(dev, buf, len); } -/*! +/** * @brief Read a set amount of data from an I2C driver * @param dev Pointer to the device structure for the driver instance * @param buf Memory pool that data should be transferred to @@ -133,7 +133,7 @@ inline int i2c_read(struct device *dev, unsigned char *buf, uint32_t len) return api->read(dev, buf, len); } -/*! +/** * @brief Suspend an I2C driver * @param dev Pointer to the device structure for the driver instance */ @@ -145,7 +145,7 @@ inline int i2c_suspend(struct device *dev) return api->suspend(dev); } -/*! +/** * @brief Resume an I2C driver * @param dev Pointer to the device structure for the driver instance */ diff --git a/include/init.h b/include/init.h index e4b16891560..1dcb18e0a3b 100644 --- a/include/init.h +++ b/include/init.h @@ -42,7 +42,7 @@ #define APP_EARLY 5 #define APP_LATE 6 -/*! @def __define_initconfig +/** @def __define_initconfig * * @brief Define an init object * diff --git a/include/misc/dlist.h b/include/misc/dlist.h index cb04f04b9e4..a60570ed5f2 100644 --- a/include/misc/dlist.h +++ b/include/misc/dlist.h @@ -58,7 +58,7 @@ struct _dnode { typedef struct _dnode sys_dlist_t; typedef struct _dnode sys_dnode_t; -/*! +/** * @brief initialize list * * @param list the doubly-linked list @@ -72,7 +72,7 @@ static inline void sys_dlist_init(sys_dlist_t *list) list->tail = (sys_dnode_t *)list; } -/*! +/** * @brief check if a node is the list's head * * @param list the doubly-linked list to operate on @@ -86,7 +86,7 @@ static inline int sys_dlist_is_head(sys_dlist_t *list, sys_dnode_t *node) return list->head == node; } -/*! +/** * @brief check if a node is the list's tail * * @param list the doubly-linked list to operate on @@ -100,7 +100,7 @@ static inline int sys_dlist_is_tail(sys_dlist_t *list, sys_dnode_t *node) return list->tail == node; } -/*! +/** * @brief check if the list is empty * * @param list the doubly-linked list to operate on @@ -113,7 +113,7 @@ static inline int sys_dlist_is_empty(sys_dlist_t *list) return list->head == list; } -/*! +/** * @brief get a reference to the head item in the list * * @param list the doubly-linked list to operate on @@ -126,7 +126,7 @@ static inline sys_dnode_t *sys_dlist_peek_head(sys_dlist_t *list) return sys_dlist_is_empty(list) ? NULL : list->head; } -/*! +/** * @brief get a reference to the next item in the list * * @param list the doubly-linked list to operate on @@ -141,7 +141,7 @@ static inline sys_dnode_t *sys_dlist_peek_next(sys_dlist_t *list, return node == list->tail ? NULL : node->next; } -/*! +/** * @brief add node to tail of list * * @param list the doubly-linked list to operate on @@ -159,7 +159,7 @@ static inline void sys_dlist_append(sys_dlist_t *list, sys_dnode_t *node) list->tail = node; } -/*! +/** * @brief add node to head of list * * @param list the doubly-linked list to operate on @@ -177,7 +177,7 @@ static inline void sys_dlist_prepend(sys_dlist_t *list, sys_dnode_t *node) list->head = node; } -/*! +/** * @brief insert node after a node * * Insert a node after a specified node in a list. @@ -202,7 +202,7 @@ static inline void sys_dlist_insert_after(sys_dlist_t *list, } } -/*! +/** * @brief insert node before a node * * Insert a node before a specified node in a list. @@ -227,7 +227,7 @@ static inline void sys_dlist_insert_before(sys_dlist_t *list, } } -/*! +/** * @brief insert node at position * * Insert a node in a location depending on a external condition. The cond() @@ -258,7 +258,7 @@ static inline void sys_dlist_insert_at(sys_dlist_t *list, sys_dnode_t *node, } } -/*! +/** * @brief remove a specific node from a list * * The list is implicit from the node. The node must be part of a list. @@ -274,7 +274,7 @@ static inline void sys_dlist_remove(sys_dnode_t *node) node->next->prev = node->prev; } -/*! +/** * @brief get the first node in a list * * @param list the doubly-linked list to operate on diff --git a/include/net/net_buf.h b/include/net/net_buf.h index 91663cecafa..3d9220b5b63 100644 --- a/include/net/net_buf.h +++ b/include/net/net_buf.h @@ -1,4 +1,4 @@ -/*! @file +/** @file @brief Network buffer API Network data is passed between application and IP stack via @@ -53,7 +53,7 @@ struct net_context; -/*! The default MTU is 1280 (minimum IPv6 packet size) + LL header +/** The default MTU is 1280 (minimum IPv6 packet size) + LL header * In Contiki terms this is UIP_LINK_MTU + UIP_LLH_LEN = UIP_BUFSIZE * * Contiki assumes that this value is UIP_BUFSIZE so do not change it @@ -62,15 +62,15 @@ struct net_context; #define NET_BUF_MAX_DATA UIP_BUFSIZE struct net_buf { - /*! @cond ignore */ + /** @cond ignore */ /* FIFO uses first 4 bytes itself, reserve space */ int __unused; /* @endcond */ - /*! Network connection context */ + /** Network connection context */ struct net_context *context; - /*! @cond ignore */ + /** @cond ignore */ /* uIP stack specific data */ uint8_t uip_ext_len; uint8_t uip_ext_bitmap; @@ -97,15 +97,15 @@ struct net_buf { uint8_t nd6_opt_offset; /* @endcond */ - /*! Buffer data length */ + /** Buffer data length */ uint16_t len; - /*! Buffer head pointer */ + /** Buffer head pointer */ uint8_t *data; - /*! Actual network buffer storage */ + /** Actual network buffer storage */ uint8_t buf[NET_BUF_MAX_DATA]; }; -/*! @cond ignore */ +/** @cond ignore */ /* Macros to access net_buf when inside Contiki stack */ #define uip_buf(buf) ((buf)->buf) #define uip_len(buf) ((buf)->len) @@ -138,7 +138,7 @@ struct net_buf { #define uip_nd6_ipaddr(buf) ((buf)->ipaddr) /* @endcond */ -/*! +/** * @brief Get buffer from the available buffers pool. * * @details Get network buffer from buffer pool. You must have @@ -157,7 +157,7 @@ struct net_buf *net_buf_get_debug(struct net_context *context, const char *calle struct net_buf *net_buf_get(struct net_context *context); #endif -/*! +/** * @brief Get buffer from pool but also reserve headroom for * potential headers. * @@ -176,7 +176,7 @@ struct net_buf *net_buf_get_reserve_debug(uint16_t reserve_head, const char *cal struct net_buf *net_buf_get_reserve(uint16_t reserve_head); #endif -/*! +/** * @brief Place buffer back into the available buffers pool. * * @details Releases the buffer to other use. This needs to be @@ -194,7 +194,7 @@ void net_buf_put_debug(struct net_buf *buf, const char *caller, int line); void net_buf_put(struct net_buf *buf); #endif -/*! +/** * @brief Prepare data to be added at the end of the buffer. * * @details Move the tail pointer forward. @@ -206,7 +206,7 @@ void net_buf_put(struct net_buf *buf); */ uint8_t *net_buf_add(struct net_buf *buf, uint16_t len); -/*! +/** * @brief Push data to the beginning of the buffer. * * @details Move the data pointer backwards. @@ -218,7 +218,7 @@ uint8_t *net_buf_add(struct net_buf *buf, uint16_t len); */ uint8_t *net_buf_push(struct net_buf *buf, uint16_t len); -/*! +/** * @brief Remove data from the beginning of the buffer. * * @details Move the data pointer forward. @@ -230,7 +230,7 @@ uint8_t *net_buf_push(struct net_buf *buf, uint16_t len); */ uint8_t *net_buf_pull(struct net_buf *buf, uint16_t len); -/*! @def net_buf_tail +/** @def net_buf_tail * * @brief Return pointer to the end of the data in the buffer. * @@ -242,11 +242,11 @@ uint8_t *net_buf_pull(struct net_buf *buf, uint16_t len); */ #define net_buf_tail(buf) ((buf)->data + (buf)->len) -/*! @cond ignore */ +/** @cond ignore */ void net_buf_init(void); /* @endcond */ -/*! For the MAC layer (after the IPv6 packet is fragmented to smaller +/** For the MAC layer (after the IPv6 packet is fragmented to smaller * chunks), we can use much smaller buffers (depending on used radio * technology). For 802.15.4 we use the 128 bytes long buffers. */ @@ -255,12 +255,12 @@ void net_buf_init(void); #endif struct net_mbuf { - /*! @cond ignore */ + /** @cond ignore */ /* FIFO uses first 4 bytes itself, reserve space */ int __unused; /* @endcond */ - /*! @cond ignore */ + /** @cond ignore */ /* 6LoWPAN pointers */ uint8_t *packetbuf_ptr; uint8_t packetbuf_hdr_len; @@ -277,7 +277,7 @@ struct net_mbuf { /* @endcond */ }; -/*! +/** * @brief Get buffer from the available buffers pool * and also reserve headroom for potential headers. * @@ -290,7 +290,7 @@ struct net_mbuf { */ struct net_mbuf *net_mbuf_get_reserve(uint16_t reserve_head); -/*! +/** * @brief Place buffer back into the available buffers pool. * * @details Releases the buffer to other use. This needs to be @@ -301,7 +301,7 @@ struct net_mbuf *net_mbuf_get_reserve(uint16_t reserve_head); */ void net_mbuf_put(struct net_mbuf *buf); -/*! @cond ignore */ +/** @cond ignore */ #define uip_packetbuf_ptr(buf) ((buf)->packetbuf_ptr) #define uip_packetbuf_hdr_len(buf) ((buf)->packetbuf_hdr_len) #define uip_packetbuf_payload_len(buf) ((buf)->packetbuf_payload_len) diff --git a/include/net/net_core.h b/include/net/net_core.h index 04fd0e7fdc3..e752d053ad4 100644 --- a/include/net/net_core.h +++ b/include/net/net_core.h @@ -1,4 +1,4 @@ -/*! @file +/** @file @brief Network core definitions Definitions for networking support. @@ -49,7 +49,7 @@ #define NET_INFO(fmt, ...) printk("net: " fmt, ##__VA_ARGS__) #define NET_PRINT(fmt, ...) printk(fmt, ##__VA_ARGS__) -/*! +/** * @brief Initialize network stack. This is will be automatically called * by the OS. * @@ -60,17 +60,17 @@ int net_init(void); struct net_driver { - /*! How much headroom is needed for net transport headers */ + /** How much headroom is needed for net transport headers */ size_t head_reserve; - /*! Open the net transport */ + /** Open the net transport */ int (*open) (void); - /*! Send data to net */ + /** Send data to net */ int (*send) (struct net_buf *buf); }; -/*! +/** * @brief Register a new network driver to the network stack. * * @details Only one network device can be registered at a time. @@ -81,7 +81,7 @@ struct net_driver { */ int net_register_driver(struct net_driver *drv); -/*! +/** * @brief Unregister a previously registered network driver. * * @param buf Network driver. @@ -92,7 +92,7 @@ int net_register_driver(struct net_driver *drv); */ void net_unregister_driver(struct net_driver *drv); -/*! +/** * @brief Set the MAC/EUI-64 address of the device. * * @details Network device driver should call this function to diff --git a/include/net/net_ip.h b/include/net/net_ip.h index acb16eb63ef..8f010f8c610 100644 --- a/include/net/net_ip.h +++ b/include/net/net_ip.h @@ -1,4 +1,4 @@ -/*! @file +/** @file @brief IPv6 and IPv4 definitions Generic IPv6 and IPv4 address definitions. @@ -39,24 +39,24 @@ #ifndef __NET_IP_H #define __NET_IP_H -/*! Protocol families */ +/** Protocol families */ #define PF_UNSPEC 0 /* Unspecified. */ #define PF_INET 2 /* IP protocol family. */ #define PF_INET6 10 /* IP version 6. */ -/*! Address families. */ +/** Address families. */ #define AF_UNSPEC PF_UNSPEC #define AF_INET PF_INET #define AF_INET6 PF_INET6 -/*! Protocol numbers from IANA */ +/** Protocol numbers from IANA */ enum ip_protocol { IPPROTO_TCP = 6, IPPROTO_UDP = 17, IPPROTO_ICMPV6 = 58, }; -/*! IPv6 address structure */ +/** IPv6 address structure */ struct in6_addr { union { uint8_t u6_addr8[16]; @@ -68,7 +68,7 @@ struct in6_addr { #define s6_addr32 in6_u.u6_addr32 }; -/*! IPv4 address */ +/** IPv4 address */ struct in_addr { union { uint8_t u4_addr8[4]; @@ -97,17 +97,17 @@ struct net_addr { #define INET6_ADDRSTRLEN 46 -/*! IPv6/IPv4 network connection tuple */ +/** IPv6/IPv4 network connection tuple */ struct net_tuple { - /*! IPv6/IPv4 remote address */ + /** IPv6/IPv4 remote address */ struct net_addr *remote_addr; - /*! IPv6/IPv4 local address */ + /** IPv6/IPv4 local address */ struct net_addr *local_addr; - /*! UDP/TCP remote port */ + /** UDP/TCP remote port */ uint16_t remote_port; - /*! UDP/TCP local port */ + /** UDP/TCP local port */ uint16_t local_port; - /*! IP protocol */ + /** IP protocol */ enum ip_protocol ip_proto; }; diff --git a/include/net/net_socket.h b/include/net/net_socket.h index c54c6dfa5f6..3fa9ad51330 100644 --- a/include/net/net_socket.h +++ b/include/net/net_socket.h @@ -1,4 +1,4 @@ -/*! @file +/** @file @brief Simple socket API Simple socket API for applications to connection establishment and @@ -42,7 +42,7 @@ #ifndef __NET_SOCKET_H #define __NET_SOCKET_H -/*! +/** * @brief Get network context. * * @details Network context is used to define the connection @@ -66,7 +66,7 @@ struct net_context *net_context_get(enum ip_protocol ip_proto, const struct net_addr *local_addr, uint16_t local_port); -/*! +/** * @brief Get network tuple. * * @details This function returns the used connection tuple. @@ -77,7 +77,7 @@ struct net_context *net_context_get(enum ip_protocol ip_proto, */ struct net_tuple *net_context_get_tuple(struct net_context *context); -/*! +/** * @brief Release network context. * * @details Free the resources allocated for the context. @@ -88,7 +88,7 @@ struct net_tuple *net_context_get_tuple(struct net_context *context); */ void net_context_put(struct net_context *context); -/*! +/** * @brief Send data to network. * * @details Send user specified data to network. This @@ -101,7 +101,7 @@ void net_context_put(struct net_context *context); */ int net_send(struct net_buf *buf); -/*! +/** * @brief Receive data from network. * * @details Application uses this to get data from network