1 /******************************************************************************
2 *  Filename:       rf_prop_mailbox.h
3 *  Revised:        2015-06-29 12:59:58 +0200 (Mon, 29 Jun 2015)
4 *  Revision:       44063
5 *
6 *  Description:    Definitions for proprietary mode radio interface
7 *
8 *  Copyright (c) 2015, Texas Instruments Incorporated
9 *  All rights reserved.
10 *
11 *  Redistribution and use in source and binary forms, with or without
12 *  modification, are permitted provided that the following conditions are met:
13 *
14 *  1) Redistributions of source code must retain the above copyright notice,
15 *     this list of conditions and the following disclaimer.
16 *
17 *  2) Redistributions in binary form must reproduce the above copyright notice,
18 *     this list of conditions and the following disclaimer in the documentation
19 *     and/or other materials provided with the distribution.
20 *
21 *  3) Neither the name of the ORGANIZATION nor the names of its contributors may
22 *     be used to endorse or promote products derived from this software without
23 *     specific prior written permission.
24 *
25 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 *  POSSIBILITY OF SUCH DAMAGE.
36 *
37 ******************************************************************************/
38 
39 #ifndef __PROP_MAILBOX_H
40 #define __PROP_MAILBOX_H
41 
42 /// \name Radio operation status
43 ///@{
44 /// \name Operation finished normally
45 ///@{
46 #define PROP_DONE_OK            0x3400  ///< Operation ended normally
47 #define PROP_DONE_RXTIMEOUT     0x3401  ///< Operation stopped after end trigger while waiting for sync
48 #define PROP_DONE_BREAK         0x3402  ///< Rx stopped due to time out in the middle of a packet
49 #define PROP_DONE_ENDED         0x3403  ///< Operation stopped after end trigger during reception
50 #define PROP_DONE_STOPPED       0x3404  ///< Operation stopped after stop command
51 #define PROP_DONE_ABORT         0x3405  ///< Operation aborted by abort command
52 #define PROP_DONE_RXERR         0x3406  ///< Operation ended after receiving packet with CRC error
53 #define PROP_DONE_IDLE          0x3407  ///< Carrier sense operation ended because of idle channel
54 #define PROP_DONE_BUSY          0x3408  ///< Carrier sense operation ended because of busy channel
55 #define PROP_DONE_IDLETIMEOUT   0x3409  ///< Carrier sense operation ended because of time out with csConf.timeoutRes = 1
56 #define PROP_DONE_BUSYTIMEOUT   0x340A  ///< Carrier sense operation ended because of time out with csConf.timeoutRes = 0
57 
58 ///@}
59 /// \name Operation finished with error
60 ///@{
61 #define PROP_ERROR_PAR          0x3800  ///< Illegal parameter
62 #define PROP_ERROR_RXBUF        0x3801  ///< No available Rx buffer at the start of a packet
63 #define PROP_ERROR_RXFULL       0x3802  ///< Out of Rx buffer during reception in a partial read buffer
64 #define PROP_ERROR_NO_SETUP     0x3803  ///< Radio was not set up in proprietary mode
65 #define PROP_ERROR_NO_FS        0x3804  ///< Synth was not programmed when running Rx or Tx
66 #define PROP_ERROR_RXOVF        0x3805  ///< Rx overflow observed during operation
67 #define PROP_ERROR_TXUNF        0x3806  ///< Tx underflow observed during operation
68 ///@}
69 ///@}
70 
71 #endif
72