alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

nrf8001: Doxygen documentation warning fixes

Browse Source 
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
John Van Drasek 2015-01-22 11:29:31 -08:00 committed by Mihai Tudor Panu
parent da321e43f5
commit 025ce478be
3 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/nrf8001/boards.h
View File

@ -26,9 +26,9 @@
#ifndef _BLE_BOARDS_H_
#define _BLE_BOARDS_H_
#define BOARD_DEFAULT 0 //Use this if you do not know the board you are using or you are creating a new one
#define REDBEARLAB_SHIELD_V1_1 1 //Redbearlab Bluetooth low energy shield v1.1
#define REDBEARLAB_SHIELD_V2012_07 1 //Identical to Redbearlab v1.1 shield
#define REDBEARLAB_SHIELD_V2 0 //Redbearlab Bluetooth low energy shield v2.x - No special handling required for pin reset same as default
#define BOARD_DEFAULT 0 //!< Use this if you do not know the board you are using or you are creating a new one
#define REDBEARLAB_SHIELD_V1_1 1 //!< Redbearlab Bluetooth low energy shield v1.1
#define REDBEARLAB_SHIELD_V2012_07 1 //!< Identical to Redbearlab v1.1 shield
#define REDBEARLAB_SHIELD_V2 0 //!< Redbearlab Bluetooth low energy shield v2.x - No special handling required for pin reset same as default
#endif

20
src/nrf8001/dtm.h
View File

@ -32,10 +32,10 @@
/** @brief DTM command codes (upper two bits in the DTM command), use a bitwise OR with the frequency N = 0x00 - 0x27: N = (F-2402)/2 Frequency Range 2402 MHz
to 2480 MHz*/
#define DTM_LE_CMD_RESET 0x00
#define DTM_LE_CMD_RECEIVER_TEST 0x40
#define DTM_LE_CMD_TRANSMITTER_TEST 0x80
#define DTM_LE_CMD_TEST_END 0xC0
#define DTM_LE_CMD_RESET 0x00 /**< DTM reset command code */
#define DTM_LE_CMD_RECEIVER_TEST 0x40 /**< DTM receiver test command code */
#define DTM_LE_CMD_TRANSMITTER_TEST 0x80 /**< DTM transmitter test command code */
#define DTM_LE_CMD_TEST_END 0xC0 /**< DTM test end command code */
/** @brief Defined packet types for DTM */
@ -45,16 +45,16 @@ to 2480 MHz*/
#define DTM_LE_PKT_VENDOR 0x03 /**< Vendor specific. Nordic: continous carrier test */
/** @brief Defined bit fields for DTM responses. */
#define LE_PACKET_REPORTING_EVENT_MSB_BIT 0x80
#define LE_TEST_STATUS_EVENT_LSB_BIT 0x01
#define LE_PACKET_REPORTING_EVENT_MSB_BIT 0x80 /**< Bit field for most significant bit */
#define LE_TEST_STATUS_EVENT_LSB_BIT 0x01 /**< Bit field for least significant bit */
/** @brief DTM response types. */
#define LE_TEST_STATUS_EVENT 0x00
#define LE_TEST_PACKET_REPORT_EVENT 0x80
#define LE_TEST_STATUS_EVENT 0x00 /**< DTM event response */
#define LE_TEST_PACKET_REPORT_EVENT 0x80 /**< DTM packet report reponse */
/** @brief DTM return values. */
#define LE_TEST_STATUS_SUCCESS 0x00
#define LE_TEST_STATUS_FAILURE 0x01
#define LE_TEST_STATUS_SUCCESS 0x00 /**< DTM success return value */
#define LE_TEST_STATUS_FAILURE 0x01 /**< DTM failure return value */

8
src/nrf8001/uart_over_ble.h
View File

@ -60,10 +60,14 @@
*/
#define UART_OVER_BLE_TRANSMIT_OK (0x04)
/**
* @struct uart_over_ble_t
* @brief State of the UART RTS over Bluetooth Low Energy(BLE)
*/
typedef struct
{
uint8_t uart_rts_local; /* State of the local UART RTS */
uint8_t uart_rts_remote; /* State of the remote UART RTS */
uint8_t uart_rts_local; /**< State of the local UART RTS */
uint8_t uart_rts_remote; /**< State of the remote UART RTS */
} uart_over_ble_t;
/**