ieee802154: move headers out of extra directory
[linux-2.6.git] / include / net / ieee802154.h
1 /*
2  * IEEE802.15.4-2003 specification
3  *
4  * Copyright (C) 2007, 2008 Siemens AG
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Written by:
20  * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
21  * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
22  * Maxim Osipov <maxim.osipov@siemens.com>
23  * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
24  */
25
26 #ifndef NET_IEEE802154_H
27 #define NET_IEEE802154_H
28
29 #define IEEE802154_FC_TYPE_BEACON       0x0     /* Frame is beacon */
30 #define IEEE802154_FC_TYPE_DATA         0x1     /* Frame is data */
31 #define IEEE802154_FC_TYPE_ACK          0x2     /* Frame is acknowledgment */
32 #define IEEE802154_FC_TYPE_MAC_CMD      0x3     /* Frame is MAC command */
33
34 #define IEEE802154_FC_TYPE_SHIFT                0
35 #define IEEE802154_FC_TYPE_MASK         ((1 << 3) - 1)
36 #define IEEE802154_FC_TYPE(x)           ((x & IEEE802154_FC_TYPE_MASK) >> IEEE802154_FC_TYPE_SHIFT)
37 #define IEEE802154_FC_SET_TYPE(v, x)    do {    \
38         v = (((v) & ~IEEE802154_FC_TYPE_MASK) | \
39             (((x) << IEEE802154_FC_TYPE_SHIFT) & IEEE802154_FC_TYPE_MASK)); \
40         } while (0)
41
42 #define IEEE802154_FC_SECEN             (1 << 3)
43 #define IEEE802154_FC_FRPEND            (1 << 4)
44 #define IEEE802154_FC_ACK_REQ           (1 << 5)
45 #define IEEE802154_FC_INTRA_PAN         (1 << 6)
46
47 #define IEEE802154_FC_SAMODE_SHIFT      14
48 #define IEEE802154_FC_SAMODE_MASK       (3 << IEEE802154_FC_SAMODE_SHIFT)
49 #define IEEE802154_FC_DAMODE_SHIFT      10
50 #define IEEE802154_FC_DAMODE_MASK       (3 << IEEE802154_FC_DAMODE_SHIFT)
51
52 #define IEEE802154_FC_SAMODE(x)         \
53         (((x) & IEEE802154_FC_SAMODE_MASK) >> IEEE802154_FC_SAMODE_SHIFT)
54
55 #define IEEE802154_FC_DAMODE(x)         \
56         (((x) & IEEE802154_FC_DAMODE_MASK) >> IEEE802154_FC_DAMODE_SHIFT)
57
58
59 /* MAC's Command Frames Identifiers */
60 #define IEEE802154_CMD_ASSOCIATION_REQ          0x01
61 #define IEEE802154_CMD_ASSOCIATION_RESP         0x02
62 #define IEEE802154_CMD_DISASSOCIATION_NOTIFY    0x03
63 #define IEEE802154_CMD_DATA_REQ                 0x04
64 #define IEEE802154_CMD_PANID_CONFLICT_NOTIFY    0x05
65 #define IEEE802154_CMD_ORPHAN_NOTIFY            0x06
66 #define IEEE802154_CMD_BEACON_REQ               0x07
67 #define IEEE802154_CMD_COORD_REALIGN_NOTIFY     0x08
68 #define IEEE802154_CMD_GTS_REQ                  0x09
69
70 /*
71  * The return values of MAC operations
72  */
73 enum {
74         /*
75          * The requested operation was completed successfully.
76          * For a transmission request, this value indicates
77          * a successful transmission.
78          */
79         IEEE802154_SUCCESS = 0x0,
80
81         /* The beacon was lost following a synchronization request. */
82         IEEE802154_BEACON_LOSS = 0xe0,
83         /*
84          * A transmission could not take place due to activity on the
85          * channel, i.e., the CSMA-CA mechanism has failed.
86          */
87         IEEE802154_CHNL_ACCESS_FAIL = 0xe1,
88         /* The GTS request has been denied by the PAN coordinator. */
89         IEEE802154_DENINED = 0xe2,
90         /* The attempt to disable the transceiver has failed. */
91         IEEE802154_DISABLE_TRX_FAIL = 0xe3,
92         /*
93          * The received frame induces a failed security check according to
94          * the security suite.
95          */
96         IEEE802154_FAILED_SECURITY_CHECK = 0xe4,
97         /*
98          * The frame resulting from secure processing has a length that is
99          * greater than aMACMaxFrameSize.
100          */
101         IEEE802154_FRAME_TOO_LONG = 0xe5,
102         /*
103          * The requested GTS transmission failed because the specified GTS
104          * either did not have a transmit GTS direction or was not defined.
105          */
106         IEEE802154_INVALID_GTS = 0xe6,
107         /*
108          * A request to purge an MSDU from the transaction queue was made using
109          * an MSDU handle that was not found in the transaction table.
110          */
111         IEEE802154_INVALID_HANDLE = 0xe7,
112         /* A parameter in the primitive is out of the valid range.*/
113         IEEE802154_INVALID_PARAMETER = 0xe8,
114         /* No acknowledgment was received after aMaxFrameRetries. */
115         IEEE802154_NO_ACK = 0xe9,
116         /* A scan operation failed to find any network beacons.*/
117         IEEE802154_NO_BEACON = 0xea,
118         /* No response data were available following a request. */
119         IEEE802154_NO_DATA = 0xeb,
120         /* The operation failed because a short address was not allocated. */
121         IEEE802154_NO_SHORT_ADDRESS = 0xec,
122         /*
123          * A receiver enable request was unsuccessful because it could not be
124          * completed within the CAP.
125          */
126         IEEE802154_OUT_OF_CAP = 0xed,
127         /*
128          * A PAN identifier conflict has been detected and communicated to the
129          * PAN coordinator.
130          */
131         IEEE802154_PANID_CONFLICT = 0xee,
132         /* A coordinator realignment command has been received. */
133         IEEE802154_REALIGMENT = 0xef,
134         /* The transaction has expired and its information discarded. */
135         IEEE802154_TRANSACTION_EXPIRED = 0xf0,
136         /* There is no capacity to store the transaction. */
137         IEEE802154_TRANSACTION_OVERFLOW = 0xf1,
138         /*
139          * The transceiver was in the transmitter enabled state when the
140          * receiver was requested to be enabled.
141          */
142         IEEE802154_TX_ACTIVE = 0xf2,
143         /* The appropriate key is not available in the ACL. */
144         IEEE802154_UNAVAILABLE_KEY = 0xf3,
145         /*
146          * A SET/GET request was issued with the identifier of a PIB attribute
147          * that is not supported.
148          */
149         IEEE802154_UNSUPPORTED_ATTR = 0xf4,
150         /*
151          * A request to perform a scan operation failed because the MLME was
152          * in the process of performing a previously initiated scan operation.
153          */
154         IEEE802154_SCAN_IN_PROGRESS = 0xfc,
155 };
156
157
158 #endif
159
160