BLE_API wrapper library for STMicroelectronics' BlueNRG Bluetooth Low Energy expansion board shield (Component)

Dependents:   Nucleo_Zumo_BLE_IDB04A1 contest_IOT5 contest_IOT6 contest_IOT_10 ... more

Fork of X_NUCLEO_IDB0XA1 by ST Expansion SW Team

Arduino Connector Compatibility Warning

X-NUCLEO-IDB04A1 and X-NUCLEO-IDB05A1 are Arduino compatible with an exception: instead of using pin D13 for the SPI clock, they use pin D3. The default configuration for this library is having the SPI clock on pin D3.

To be fully Arduino compatible, X-NUCLEO-IDB04A1 and X-NUCLEO-IDB05A1 need a small HW patch.

For X-NUCLEO-IDB04A1 this patch consists in removing zero resistor R10 and instead soldering zero resistor R11. For X-NUCLEO-IDB05A1 this patch consists in removing zero resistor R4 and instead soldering zero resistor R6.

In case you patch your board, then you also have to configure this library to use pin D13 to drive the SPI clock (see macro IDB0XA1_D13_PATCH in file x_nucleo_idb0xa1_targets.h).

If you use pin D13 for the SPI clock, please be aware that on STM32 Nucleo boards you may not drive the LED, otherwise you will get a conflict: the LED on STM32 Nucleo boards is connected to pin D13.

Referring to the current list of tested platforms (see X-NUCLEO-IDB04A1 and X-NUCLEO-IDB05A1 pages), the patch is required by ST-Nucleo-F103RB; ST-Nucleo-F302R8; ST-Nucleo-F411RE; and ST-Nucleo-F446RE.

Committer:
Andrea Palmieri
Date:
Fri Sep 16 12:03:25 2016 +0200
Revision:
307:fa98703ece8e
Parent:
283:998f6b1fe1b7
Sync with 21bfd161ace255bb6214d6b74cae1fd30b3e24c9

2016-09-16 11:53:47+02:00: Andrea Palmieri
Get rid of warnings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 132:51056160fa4a 1 /******************** (C) COPYRIGHT 2012 STMicroelectronics ********************
Wolfgang Betz 132:51056160fa4a 2 * File Name : ble_status.h
Wolfgang Betz 132:51056160fa4a 3 * Author : AMS - HEA&RF BU
Wolfgang Betz 132:51056160fa4a 4 * Version : V1.0.0
Wolfgang Betz 132:51056160fa4a 5 * Date : 19-July-2012
Wolfgang Betz 132:51056160fa4a 6 * Description : Header file with BLE Stack status codes.
Wolfgang Betz 132:51056160fa4a 7 ********************************************************************************
Wolfgang Betz 132:51056160fa4a 8 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
Wolfgang Betz 132:51056160fa4a 9 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
Wolfgang Betz 132:51056160fa4a 10 * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
Wolfgang Betz 132:51056160fa4a 11 * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
Wolfgang Betz 132:51056160fa4a 12 * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
Wolfgang Betz 132:51056160fa4a 13 * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
Wolfgang Betz 132:51056160fa4a 14 *******************************************************************************/
Wolfgang Betz 132:51056160fa4a 15 #ifndef __BLE_STATUS_H__
Wolfgang Betz 132:51056160fa4a 16 #define __BLE_STATUS_H__
Wolfgang Betz 132:51056160fa4a 17
Vincent Coubard 283:998f6b1fe1b7 18 #include <ble_hal_types.h>
Wolfgang Betz 132:51056160fa4a 19
Wolfgang Betz 132:51056160fa4a 20
Wolfgang Betz 132:51056160fa4a 21 /** @defgroup ble_status Bluetooth Status/Error Codes
Wolfgang Betz 132:51056160fa4a 22 * @{
Wolfgang Betz 132:51056160fa4a 23 */
Wolfgang Betz 132:51056160fa4a 24
Wolfgang Betz 132:51056160fa4a 25 typedef uint8_t tBleStatus;
Wolfgang Betz 132:51056160fa4a 26
Wolfgang Betz 132:51056160fa4a 27 /* Error Codes as specified by the specification
Wolfgang Betz 132:51056160fa4a 28 * according to the spec the error codes range
Wolfgang Betz 132:51056160fa4a 29 * from 0x00 to 0x3F
Wolfgang Betz 132:51056160fa4a 30 */
Wolfgang Betz 132:51056160fa4a 31 #define ERR_CMD_SUCCESS (0x00)
Wolfgang Betz 132:51056160fa4a 32 #define BLE_STATUS_SUCCESS (0x00)
Wolfgang Betz 132:51056160fa4a 33 #define ERR_UNKNOWN_HCI_COMMAND (0x01)
Wolfgang Betz 132:51056160fa4a 34 #define ERR_UNKNOWN_CONN_IDENTIFIER (0x02)
Wolfgang Betz 132:51056160fa4a 35
Wolfgang Betz 132:51056160fa4a 36 #define ERR_AUTH_FAILURE (0x05)
Wolfgang Betz 132:51056160fa4a 37 #define ERR_PIN_OR_KEY_MISSING (0x06)
Wolfgang Betz 132:51056160fa4a 38 #define ERR_MEM_CAPACITY_EXCEEDED (0x07)
Wolfgang Betz 132:51056160fa4a 39 #define ERR_CONNECTION_TIMEOUT (0x08)
Wolfgang Betz 132:51056160fa4a 40
Wolfgang Betz 132:51056160fa4a 41 #define ERR_COMMAND_DISALLOWED (0x0C)
Wolfgang Betz 132:51056160fa4a 42
Wolfgang Betz 132:51056160fa4a 43 #define ERR_UNSUPPORTED_FEATURE (0x11)
Wolfgang Betz 132:51056160fa4a 44 #define ERR_INVALID_HCI_CMD_PARAMS (0x12)
Wolfgang Betz 132:51056160fa4a 45 #define ERR_RMT_USR_TERM_CONN (0x13)
Wolfgang Betz 132:51056160fa4a 46 #define ERR_RMT_DEV_TERM_CONN_LOW_RESRCES (0x14)
Wolfgang Betz 132:51056160fa4a 47 #define ERR_RMT_DEV_TERM_CONN_POWER_OFF (0x15)
Wolfgang Betz 132:51056160fa4a 48 #define ERR_LOCAL_HOST_TERM_CONN (0x16)
Wolfgang Betz 132:51056160fa4a 49
Wolfgang Betz 132:51056160fa4a 50 #define ERR_UNSUPP_RMT_FEATURE (0x1A)
Wolfgang Betz 132:51056160fa4a 51
Wolfgang Betz 132:51056160fa4a 52 #define ERR_INVALID_LMP_PARAM (0x1E)
Wolfgang Betz 132:51056160fa4a 53 #define ERR_UNSPECIFIED_ERROR (0x1F)
Wolfgang Betz 132:51056160fa4a 54
Wolfgang Betz 132:51056160fa4a 55 #define ERR_LL_RESP_TIMEOUT (0x22)
Wolfgang Betz 132:51056160fa4a 56 #define ERR_LMP_PDU_NOT_ALLOWED (0x24)
Wolfgang Betz 132:51056160fa4a 57
Wolfgang Betz 132:51056160fa4a 58 #define ERR_INSTANT_PASSED (0x28)
Wolfgang Betz 132:51056160fa4a 59
Wolfgang Betz 132:51056160fa4a 60 #define ERR_PAIR_UNIT_KEY_NOT_SUPP (0x29)
Wolfgang Betz 132:51056160fa4a 61 #define ERR_CONTROLLER_BUSY (0x3A)
Wolfgang Betz 132:51056160fa4a 62
Wolfgang Betz 132:51056160fa4a 63 #define ERR_DIRECTED_ADV_TIMEOUT (0x3C)
Wolfgang Betz 132:51056160fa4a 64
Wolfgang Betz 132:51056160fa4a 65 #define ERR_CONN_END_WITH_MIC_FAILURE (0x3D)
Wolfgang Betz 132:51056160fa4a 66
Wolfgang Betz 132:51056160fa4a 67 #define ERR_CONN_FAILED_TO_ESTABLISH (0x3E)
Wolfgang Betz 132:51056160fa4a 68
Wolfgang Betz 132:51056160fa4a 69
Wolfgang Betz 132:51056160fa4a 70 #define BLE_STATUS_FAILED (0x41)
Wolfgang Betz 132:51056160fa4a 71 #define BLE_STATUS_INVALID_PARAMS (0x42)
Wolfgang Betz 132:51056160fa4a 72 #define BLE_STATUS_BUSY (0x43)
Wolfgang Betz 132:51056160fa4a 73 #define BLE_STATUS_INVALID_LEN_PDU (0x44)
Wolfgang Betz 132:51056160fa4a 74 #define BLE_STATUS_PENDING (0x45)
Wolfgang Betz 132:51056160fa4a 75 #define BLE_STATUS_NOT_ALLOWED (0x46)
Wolfgang Betz 132:51056160fa4a 76 #define BLE_STATUS_ERROR (0x47)
Wolfgang Betz 132:51056160fa4a 77 #define BLE_STATUS_ADDR_NOT_RESOLVED (0x48)
Wolfgang Betz 132:51056160fa4a 78
Wolfgang Betz 132:51056160fa4a 79 #define FLASH_READ_FAILED (0x49)
Wolfgang Betz 132:51056160fa4a 80 #define FLASH_WRITE_FAILED (0x4A)
Wolfgang Betz 132:51056160fa4a 81 #define FLASH_ERASE_FAILED (0x4B)
Wolfgang Betz 132:51056160fa4a 82
Wolfgang Betz 132:51056160fa4a 83 #define BLE_STATUS_INVALID_CID (0x50)
Wolfgang Betz 132:51056160fa4a 84
Wolfgang Betz 132:51056160fa4a 85 #define TIMER_NOT_VALID_LAYER (0x54)
Wolfgang Betz 132:51056160fa4a 86 #define TIMER_INSUFFICIENT_RESOURCES (0x55)
Wolfgang Betz 132:51056160fa4a 87
Wolfgang Betz 132:51056160fa4a 88 #define BLE_STATUS_CSRK_NOT_FOUND (0x5A)
Wolfgang Betz 132:51056160fa4a 89 #define BLE_STATUS_IRK_NOT_FOUND (0x5B)
Wolfgang Betz 132:51056160fa4a 90 #define BLE_STATUS_DEV_NOT_FOUND_IN_DB (0x5C)
Wolfgang Betz 132:51056160fa4a 91 #define BLE_STATUS_SEC_DB_FULL (0x5D)
Wolfgang Betz 132:51056160fa4a 92 #define BLE_STATUS_DEV_NOT_BONDED (0x5E)
Wolfgang Betz 132:51056160fa4a 93 #define BLE_STATUS_DEV_IN_BLACKLIST (0x5F)
Wolfgang Betz 132:51056160fa4a 94
Wolfgang Betz 132:51056160fa4a 95 #define BLE_STATUS_INVALID_HANDLE (0x60)
Wolfgang Betz 132:51056160fa4a 96 #define BLE_STATUS_INVALID_PARAMETER (0x61)
Wolfgang Betz 132:51056160fa4a 97 #define BLE_STATUS_OUT_OF_HANDLE (0x62)
Wolfgang Betz 132:51056160fa4a 98 #define BLE_STATUS_INVALID_OPERATION (0x63)
Wolfgang Betz 132:51056160fa4a 99 #define BLE_STATUS_INSUFFICIENT_RESOURCES (0x64)
Wolfgang Betz 132:51056160fa4a 100 #define BLE_INSUFFICIENT_ENC_KEYSIZE (0x65)
Wolfgang Betz 132:51056160fa4a 101 #define BLE_STATUS_CHARAC_ALREADY_EXISTS (0x66)
Wolfgang Betz 132:51056160fa4a 102
Wolfgang Betz 132:51056160fa4a 103 /*
Wolfgang Betz 132:51056160fa4a 104 * Library Error Codes
Wolfgang Betz 132:51056160fa4a 105 */
Wolfgang Betz 132:51056160fa4a 106 #define BLE_STATUS_TIMEOUT (0xFF)
Wolfgang Betz 132:51056160fa4a 107 #define BLE_STATUS_PROFILE_ALREADY_INITIALIZED (0xF0)
Wolfgang Betz 132:51056160fa4a 108 #define BLE_STATUS_NULL_PARAM (0xF1)
Wolfgang Betz 132:51056160fa4a 109
Wolfgang Betz 132:51056160fa4a 110 /**
Wolfgang Betz 132:51056160fa4a 111 * @}
Wolfgang Betz 132:51056160fa4a 112 */
Wolfgang Betz 132:51056160fa4a 113
Wolfgang Betz 132:51056160fa4a 114
Vincent Coubard 283:998f6b1fe1b7 115 #endif /* __BLE_STATUS_H__ */