1 /******************************************************************************
2 *  Filename:       rf_ble_mailbox.h
3 *
4 *  Description:    Definitions for BLE interface
5 *
6 *  Copyright (c) 2015 - 2020, Texas Instruments Incorporated
7 *  All rights reserved.
8 *
9 *  Redistribution and use in source and binary forms, with or without
10 *  modification, are permitted provided that the following conditions are met:
11 *
12 *  1) Redistributions of source code must retain the above copyright notice,
13 *     this list of conditions and the following disclaimer.
14 *
15 *  2) Redistributions in binary form must reproduce the above copyright notice,
16 *     this list of conditions and the following disclaimer in the documentation
17 *     and/or other materials provided with the distribution.
18 *
19 *  3) Neither the name of the ORGANIZATION nor the names of its contributors may
20 *     be used to endorse or promote products derived from this software without
21 *     specific prior written permission.
22 *
23 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 *  POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************/
36 
37 #ifndef _BLE_MAILBOX_H
38 #define _BLE_MAILBOX_H
39 
40 /// \name Radio operation status
41 ///@{
42 /// \name Operation finished normally
43 ///@{
44 #define BLE_DONE_OK             0x1400  ///< Operation ended normally
45 #define BLE_DONE_RXTIMEOUT      0x1401  ///< Timeout of first Rx of slave operation or end of scan window
46 #define BLE_DONE_NOSYNC         0x1402  ///< Timeout of subsequent Rx
47 #define BLE_DONE_RXERR          0x1403  ///< Operation ended because of receive error (CRC or other)
48 #define BLE_DONE_CONNECT        0x1404  ///< CONNECT_IND or AUX_CONNECT_RSP received or transmitted
49 #define BLE_DONE_MAXNACK        0x1405  ///< Maximum number of retransmissions exceeded
50 #define BLE_DONE_ENDED          0x1406  ///< Operation stopped after end trigger
51 #define BLE_DONE_ABORT          0x1407  ///< Operation aborted by command
52 #define BLE_DONE_STOPPED        0x1408  ///< Operation stopped after stop command
53 #define BLE_DONE_AUX            0x1409  ///< Operation ended after following aux pointer pointing far ahead
54 #define BLE_DONE_CONNECT_CHSEL0 0x140A  ///< CONNECT_IND received or transmitted; peer does not support channel selection algorithm #2
55 #define BLE_DONE_SCAN_RSP       0x140B  ///< SCAN_RSP or AUX_SCAN_RSP transmitted
56 ///@}
57 /// \name Operation finished with error
58 ///@{
59 #define BLE_ERROR_PAR           0x1800  ///< Illegal parameter
60 #define BLE_ERROR_RXBUF         0x1801  ///< No available Rx buffer (Advertiser, Scanner, Initiator)
61 #define BLE_ERROR_NO_SETUP      0x1802  ///< Operation using Rx or Tx attempted when not in BLE mode
62 #define BLE_ERROR_NO_FS         0x1803  ///< Operation using Rx or Tx attempted without frequency synth configured
63 #define BLE_ERROR_SYNTH_PROG    0x1804  ///< Synthesizer programming failed to complete on time
64 #define BLE_ERROR_RXOVF         0x1805  ///< Receiver overflowed during operation
65 #define BLE_ERROR_TXUNF         0x1806  ///< Transmitter underflowed during operation
66 #define BLE_ERROR_AUX           0x1807  ///< Calculated AUX pointer was too far into the future or in the past
67 ///@}
68 ///@}
69 
70 
71 /// Special trigger for BLE slave command
72 #define BLE_TRIG_REL_SYNC       15
73 
74 #endif
75