2 * IEEE802.15.4-2003 specification
4 * Copyright (C) 2007-2012 Siemens AG
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.
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.
16 #ifndef NET_MAC802154_H
17 #define NET_MAC802154_H
19 #include <net/af_ieee802154.h>
20 #include <linux/skbuff.h>
22 /* General MAC frame format:
23 * 2 bytes: Frame Control
24 * 1 byte: Sequence Number
25 * 20 bytes: Addressing fields
26 * 14 bytes: Auxiliary Security Header
28 #define MAC802154_FRAME_HARD_HEADER_LEN (2 + 1 + 20 + 14)
30 /* The following flags are used to indicate changed address settings from
31 * the stack to the hardware.
34 /* indicates that the Short Address changed */
35 #define IEEE802154_AFILT_SADDR_CHANGED 0x00000001
36 /* indicates that the IEEE Address changed */
37 #define IEEE802154_AFILT_IEEEADDR_CHANGED 0x00000002
38 /* indicates that the PAN ID changed */
39 #define IEEE802154_AFILT_PANID_CHANGED 0x00000004
40 /* indicates that PAN Coordinator status changed */
41 #define IEEE802154_AFILT_PANC_CHANGED 0x00000008
43 struct ieee802154_hw_addr_filt
{
44 __le16 pan_id
; /* Each independent PAN selects a unique
45 * identifier. This PAN id allows communication
46 * between devices within a network using short
47 * addresses and enables transmissions between
48 * devices across independent networks.
55 struct ieee802154_hw
{
56 /* filled by the driver */
57 int extra_tx_headroom
;
59 struct device
*parent
;
61 /* filled by mac802154 core */
62 struct ieee802154_hw_addr_filt hw_filt
;
67 /* Checksum is in hardware and is omitted from a packet
69 * These following flags are used to indicate hardware capabilities to
70 * the stack. Generally, flags here should have their meaning
71 * done in a way that the simplest hardware doesn't need setting
72 * any particular flags. There are some exceptions to this rule,
73 * however, so you are advised to review these flags carefully.
76 /* Indicates that receiver omits FCS and xmitter will add FCS on it's own. */
77 #define IEEE802154_HW_OMIT_CKSUM 0x00000001
78 /* Indicates that receiver will autorespond with ACK frames. */
79 #define IEEE802154_HW_AACK 0x00000002
80 /* Indicates that transceiver will support transmit power setting. */
81 #define IEEE802154_HW_TXPOWER 0x00000004
82 /* Indicates that transceiver will support listen before transmit. */
83 #define IEEE802154_HW_LBT 0x00000008
84 /* Indicates that transceiver will support cca mode setting. */
85 #define IEEE802154_HW_CCA_MODE 0x00000010
86 /* Indicates that transceiver will support cca ed level setting. */
87 #define IEEE802154_HW_CCA_ED_LEVEL 0x00000020
88 /* Indicates that transceiver will support csma (max_be, min_be, csma retries)
90 #define IEEE802154_HW_CSMA_PARAMS 0x00000040
91 /* Indicates that transceiver will support ARET frame retries setting. */
92 #define IEEE802154_HW_FRAME_RETRIES 0x00000080
94 /* This groups the most common CSMA support fields into one. */
95 #define IEEE802154_HW_CSMA (IEEE802154_HW_CCA_MODE | \
96 IEEE802154_HW_CCA_ED_LEVEL | \
97 IEEE802154_HW_CSMA_PARAMS | \
98 IEEE802154_HW_FRAME_RETRIES)
100 /* struct ieee802154_ops - callbacks from mac802154 to the driver
102 * This structure contains various callbacks that the driver may
103 * handle or, in some cases, must handle, for example to transmit
106 * start: Handler that 802.15.4 module calls for device initialization.
107 * This function is called before the first interface is attached.
109 * stop: Handler that 802.15.4 module calls for device cleanup.
110 * This function is called after the last interface is removed.
112 * xmit: Handler that 802.15.4 module calls for each transmitted frame.
113 * skb cntains the buffer starting from the IEEE 802.15.4 header.
114 * The low-level driver should send the frame based on available
116 * This function should return zero or negative errno.
118 * ed: Handler that 802.15.4 module calls for Energy Detection.
119 * This function should place the value for detected energy
120 * (usually device-dependant) in the level pointer and return
121 * either zero or negative errno. Called with pib_lock held.
124 * Set radio for listening on specific channel.
125 * Set the device for listening on specified channel.
126 * Returns either zero, or negative errno. Called with pib_lock held.
129 * Set radio for listening on specific address.
130 * Set the device for listening on specified address.
131 * Returns either zero, or negative errno.
134 * Set radio transmit power in dB. Called with pib_lock held.
135 * Returns either zero, or negative errno.
138 * Enables or disables listen before talk on the device. Called with
140 * Returns either zero, or negative errno.
143 * Sets the CCA mode used by the device. Called with pib_lock held.
144 * Returns either zero, or negative errno.
147 * Sets the CCA energy detection threshold in dBm. Called with pib_lock
149 * Returns either zero, or negative errno.
152 * Sets the CSMA parameter set for the PHY. Called with pib_lock held.
153 * Returns either zero, or negative errno.
156 * Sets the retransmission attempt limit. Called with pib_lock held.
157 * Returns either zero, or negative errno.
159 struct ieee802154_ops
{
160 struct module
*owner
;
161 int (*start
)(struct ieee802154_hw
*hw
);
162 void (*stop
)(struct ieee802154_hw
*hw
);
163 int (*xmit
)(struct ieee802154_hw
*hw
,
164 struct sk_buff
*skb
);
165 int (*ed
)(struct ieee802154_hw
*hw
, u8
*level
);
166 int (*set_channel
)(struct ieee802154_hw
*hw
,
169 int (*set_hw_addr_filt
)(struct ieee802154_hw
*hw
,
170 struct ieee802154_hw_addr_filt
*filt
,
171 unsigned long changed
);
172 int (*set_txpower
)(struct ieee802154_hw
*hw
, int db
);
173 int (*set_lbt
)(struct ieee802154_hw
*hw
, bool on
);
174 int (*set_cca_mode
)(struct ieee802154_hw
*hw
, u8 mode
);
175 int (*set_cca_ed_level
)(struct ieee802154_hw
*hw
,
177 int (*set_csma_params
)(struct ieee802154_hw
*hw
,
178 u8 min_be
, u8 max_be
, u8 retries
);
179 int (*set_frame_retries
)(struct ieee802154_hw
*hw
,
183 /* Basic interface to register ieee802154 hwice */
184 struct ieee802154_hw
*
185 ieee802154_alloc_hw(size_t priv_data_len
, struct ieee802154_ops
*ops
);
186 void ieee802154_free_hw(struct ieee802154_hw
*hw
);
187 int ieee802154_register_hw(struct ieee802154_hw
*hw
);
188 void ieee802154_unregister_hw(struct ieee802154_hw
*hw
);
190 void ieee802154_rx_irqsafe(struct ieee802154_hw
*hw
, struct sk_buff
*skb
,
193 #endif /* NET_MAC802154_H */