1 /******************************************************************************
2 *  Filename:       rf_ieee_mailbox.h
3 *
4 *  Description:    Definitions for IEEE 802.15.4 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 _IEEE_MAILBOX_H
38 #define _IEEE_MAILBOX_H
39 
40 #include "rf_mailbox.h"
41 
42 /// \name Radio operation status
43 ///@{
44 /// \name Operation not finished
45 ///@{
46 #define IEEE_SUSPENDED          0x2001  ///< Operation suspended
47 ///@}
48 /// \name Operation finished normally
49 ///@{
50 #define IEEE_DONE_OK            0x2400  ///< Operation ended normally
51 #define IEEE_DONE_BUSY          0x2401  ///< CSMA-CA operation ended with failure
52 #define IEEE_DONE_STOPPED       0x2402  ///< Operation stopped after stop command
53 #define IEEE_DONE_ACK           0x2403  ///< ACK packet received with pending data bit cleared
54 #define IEEE_DONE_ACKPEND       0x2404  ///< ACK packet received with pending data bit set
55 #define IEEE_DONE_TIMEOUT       0x2405  ///< Operation ended due to timeout
56 #define IEEE_DONE_BGEND         0x2406  ///< FG operation ended because necessary background level
57                                         ///< operation ended
58 #define IEEE_DONE_ABORT         0x2407  ///< Operation aborted by command
59 ///@}
60 /// \name Operation finished with error
61 ///@{
62 #define IEEE_ERROR_PAR          0x2800  ///< Illegal parameter
63 #define IEEE_ERROR_NO_SETUP     0x2801  ///< Operation using Rx or Tx attempted when not in 15.4 mode
64 #define IEEE_ERROR_NO_FS        0x2802  ///< Operation using Rx or Tx attempted without frequency synth configured
65 #define IEEE_ERROR_SYNTH_PROG   0x2803  ///< Synthesizer programming failed to complete on time
66 #define IEEE_ERROR_RXOVF        0x2804  ///< Receiver overflowed during operation
67 #define IEEE_ERROR_TXUNF        0x2805  ///< Transmitter underflowed during operation
68 ///@}
69 ///@}
70 
71 #endif
72