2 * Sample driver for HardMAC IEEE 802.15.4 devices
4 * Copyright (C) 2009 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.
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.
20 * Dmitry Eremin-Solenikov <dmitry.baryshkov@siemens.com>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/netdevice.h>
26 #include <linux/skbuff.h>
27 #include <linux/if_arp.h>
29 #include <net/af_ieee802154.h>
30 #include <net/ieee802154_netdev.h>
31 #include <net/ieee802154.h>
32 #include <net/nl802154.h>
33 #include <net/wpan-phy.h>
35 struct wpan_phy
*net_to_phy(struct net_device
*dev
)
37 return container_of(dev
->dev
.parent
, struct wpan_phy
, dev
);
41 * fake_get_pan_id - Retrieve the PAN ID of the device.
42 * @dev: The network device to retrieve the PAN of.
44 * Return the ID of the PAN from the PIB.
46 static u16
fake_get_pan_id(struct net_device
*dev
)
48 BUG_ON(dev
->type
!= ARPHRD_IEEE802154
);
54 * fake_get_short_addr - Retrieve the short address of the device.
55 * @dev: The network device to retrieve the short address of.
57 * Returns the IEEE 802.15.4 short-form address cached for this
58 * device. If the device has not yet had a short address assigned
59 * then this should return 0xFFFF to indicate a lack of association.
61 static u16
fake_get_short_addr(struct net_device
*dev
)
63 BUG_ON(dev
->type
!= ARPHRD_IEEE802154
);
69 * fake_get_dsn - Retrieve the DSN of the device.
70 * @dev: The network device to retrieve the DSN for.
72 * Returns the IEEE 802.15.4 DSN for the network device.
73 * The DSN is the sequence number which will be added to each
74 * packet or MAC command frame by the MAC during transmission.
76 * DSN means 'Data Sequence Number'.
78 * Note: This is in section 7.2.1.2 of the IEEE 802.15.4-2006
81 static u8
fake_get_dsn(struct net_device
*dev
)
83 BUG_ON(dev
->type
!= ARPHRD_IEEE802154
);
85 return 0x00; /* DSN are implemented in HW, so return just 0 */
89 * fake_get_bsn - Retrieve the BSN of the device.
90 * @dev: The network device to retrieve the BSN for.
92 * Returns the IEEE 802.15.4 BSN for the network device.
93 * The BSN is the sequence number which will be added to each
94 * beacon frame sent by the MAC.
96 * BSN means 'Beacon Sequence Number'.
98 * Note: This is in section 7.2.1.2 of the IEEE 802.15.4-2006
101 static u8
fake_get_bsn(struct net_device
*dev
)
103 BUG_ON(dev
->type
!= ARPHRD_IEEE802154
);
105 return 0x00; /* BSN are implemented in HW, so return just 0 */
109 * fake_assoc_req - Make an association request to the HW.
110 * @dev: The network device which we are associating to a network.
111 * @addr: The coordinator with which we wish to associate.
112 * @channel: The channel on which to associate.
113 * @cap: The capability information field to use in the association.
115 * Start an association with a coordinator. The coordinator's address
116 * and PAN ID can be found in @addr.
118 * Note: This is in section 7.3.1 and 7.5.3.1 of the IEEE
119 * 802.15.4-2006 document.
121 static int fake_assoc_req(struct net_device
*dev
,
122 struct ieee802154_addr
*addr
, u8 channel
, u8 page
, u8 cap
)
124 struct wpan_phy
*phy
= net_to_phy(dev
);
126 mutex_lock(&phy
->pib_lock
);
127 phy
->current_channel
= channel
;
128 phy
->current_page
= page
;
129 mutex_unlock(&phy
->pib_lock
);
131 /* We simply emulate it here */
132 return ieee802154_nl_assoc_confirm(dev
, fake_get_short_addr(dev
),
137 * fake_assoc_resp - Send an association response to a device.
138 * @dev: The network device on which to send the response.
139 * @addr: The address of the device to respond to.
140 * @short_addr: The assigned short address for the device (if any).
141 * @status: The result of the association request.
143 * Queue the association response of the coordinator to another
144 * device's attempt to associate with the network which we
145 * coordinate. This is then added to the indirect-send queue to be
146 * transmitted to the end device when it polls for data.
148 * Note: This is in section 7.3.2 and 7.5.3.1 of the IEEE
149 * 802.15.4-2006 document.
151 static int fake_assoc_resp(struct net_device
*dev
,
152 struct ieee802154_addr
*addr
, u16 short_addr
, u8 status
)
158 * fake_disassoc_req - Disassociate a device from a network.
159 * @dev: The network device on which we're disassociating a device.
160 * @addr: The device to disassociate from the network.
161 * @reason: The reason to give to the device for being disassociated.
163 * This sends a disassociation notification to the device being
164 * disassociated from the network.
166 * Note: This is in section 7.5.3.2 of the IEEE 802.15.4-2006
167 * document, with the reason described in 7.3.3.2.
169 static int fake_disassoc_req(struct net_device
*dev
,
170 struct ieee802154_addr
*addr
, u8 reason
)
172 return ieee802154_nl_disassoc_confirm(dev
, IEEE802154_SUCCESS
);
176 * fake_start_req - Start an IEEE 802.15.4 PAN.
177 * @dev: The network device on which to start the PAN.
178 * @addr: The coordinator address to use when starting the PAN.
179 * @channel: The channel on which to start the PAN.
180 * @bcn_ord: Beacon order.
181 * @sf_ord: Superframe order.
182 * @pan_coord: Whether or not we are the PAN coordinator or just
183 * requesting a realignment perhaps?
184 * @blx: Battery Life Extension feature bitfield.
185 * @coord_realign: Something to realign something else.
187 * If pan_coord is non-zero then this starts a network with the
188 * provided parameters, otherwise it attempts a coordinator
189 * realignment of the stated network instead.
191 * Note: This is in section 7.5.2.3 of the IEEE 802.15.4-2006
192 * document, with 7.3.8 describing coordinator realignment.
194 static int fake_start_req(struct net_device
*dev
, struct ieee802154_addr
*addr
,
196 u8 bcn_ord
, u8 sf_ord
, u8 pan_coord
, u8 blx
,
199 struct wpan_phy
*phy
= net_to_phy(dev
);
201 mutex_lock(&phy
->pib_lock
);
202 phy
->current_channel
= channel
;
203 phy
->current_page
= page
;
204 mutex_unlock(&phy
->pib_lock
);
206 /* We don't emulate beacons here at all, so START should fail */
207 ieee802154_nl_start_confirm(dev
, IEEE802154_INVALID_PARAMETER
);
212 * fake_scan_req - Start a channel scan.
213 * @dev: The network device on which to perform a channel scan.
214 * @type: The type of scan to perform.
215 * @channels: The channel bitmask to scan.
216 * @duration: How long to spend on each channel.
218 * This starts either a passive (energy) scan or an active (PAN) scan
219 * on the channels indicated in the @channels bitmask. The duration of
220 * the scan is measured in terms of superframe duration. Specifically,
221 * the scan will spend aBaseSuperFrameDuration * ((2^n) + 1) on each
224 * Note: This is in section 7.5.2.1 of the IEEE 802.15.4-2006 document.
226 static int fake_scan_req(struct net_device
*dev
, u8 type
, u32 channels
,
227 u8 page
, u8 duration
)
230 return ieee802154_nl_scan_confirm(dev
, IEEE802154_SUCCESS
, type
,
232 type
== IEEE802154_MAC_SCAN_ED
? edl
: NULL
);
235 static struct ieee802154_mlme_ops fake_mlme
= {
236 .assoc_req
= fake_assoc_req
,
237 .assoc_resp
= fake_assoc_resp
,
238 .disassoc_req
= fake_disassoc_req
,
239 .start_req
= fake_start_req
,
240 .scan_req
= fake_scan_req
,
242 .get_pan_id
= fake_get_pan_id
,
243 .get_short_addr
= fake_get_short_addr
,
244 .get_dsn
= fake_get_dsn
,
245 .get_bsn
= fake_get_bsn
,
248 static int ieee802154_fake_open(struct net_device
*dev
)
250 netif_start_queue(dev
);
254 static int ieee802154_fake_close(struct net_device
*dev
)
256 netif_stop_queue(dev
);
260 static netdev_tx_t
ieee802154_fake_xmit(struct sk_buff
*skb
,
261 struct net_device
*dev
)
263 skb
->iif
= dev
->ifindex
;
265 dev
->stats
.tx_packets
++;
266 dev
->stats
.tx_bytes
+= skb
->len
;
268 dev
->trans_start
= jiffies
;
270 /* FIXME: do hardware work here ... */
276 static int ieee802154_fake_ioctl(struct net_device
*dev
, struct ifreq
*ifr
,
279 struct sockaddr_ieee802154
*sa
=
280 (struct sockaddr_ieee802154
*)&ifr
->ifr_addr
;
281 u16 pan_id
, short_addr
;
285 /* FIXME: fixed here, get from device IRL */
286 pan_id
= fake_get_pan_id(dev
);
287 short_addr
= fake_get_short_addr(dev
);
288 if (pan_id
== IEEE802154_PANID_BROADCAST
||
289 short_addr
== IEEE802154_ADDR_BROADCAST
)
290 return -EADDRNOTAVAIL
;
292 sa
->family
= AF_IEEE802154
;
293 sa
->addr
.addr_type
= IEEE802154_ADDR_SHORT
;
294 sa
->addr
.pan_id
= pan_id
;
295 sa
->addr
.short_addr
= short_addr
;
301 static int ieee802154_fake_mac_addr(struct net_device
*dev
, void *p
)
303 return -EBUSY
; /* HW address is built into the device */
306 static const struct net_device_ops fake_ops
= {
307 .ndo_open
= ieee802154_fake_open
,
308 .ndo_stop
= ieee802154_fake_close
,
309 .ndo_start_xmit
= ieee802154_fake_xmit
,
310 .ndo_do_ioctl
= ieee802154_fake_ioctl
,
311 .ndo_set_mac_address
= ieee802154_fake_mac_addr
,
314 static void ieee802154_fake_destruct(struct net_device
*dev
)
316 struct wpan_phy
*phy
= net_to_phy(dev
);
318 wpan_phy_unregister(phy
);
323 static void ieee802154_fake_setup(struct net_device
*dev
)
325 dev
->addr_len
= IEEE802154_ADDR_LEN
;
326 memset(dev
->broadcast
, 0xff, IEEE802154_ADDR_LEN
);
327 dev
->features
= NETIF_F_NO_CSUM
;
328 dev
->needed_tailroom
= 2; /* FCS */
330 dev
->tx_queue_len
= 10;
331 dev
->type
= ARPHRD_IEEE802154
;
332 dev
->flags
= IFF_NOARP
| IFF_BROADCAST
;
333 dev
->watchdog_timeo
= 0;
334 dev
->destructor
= ieee802154_fake_destruct
;
338 static int __devinit
ieee802154fake_probe(struct platform_device
*pdev
)
340 struct net_device
*dev
;
341 struct wpan_phy
*phy
= wpan_phy_alloc(0);
347 dev
= alloc_netdev(0, "hardwpan%d", ieee802154_fake_setup
);
353 phy
->dev
.platform_data
= dev
;
355 memcpy(dev
->dev_addr
, "\xba\xbe\xca\xfe\xde\xad\xbe\xef",
357 memcpy(dev
->perm_addr
, dev
->dev_addr
, dev
->addr_len
);
359 phy
->channels_supported
= (1 << 27) - 1;
360 phy
->transmit_power
= 0xbf;
362 dev
->netdev_ops
= &fake_ops
;
363 dev
->ml_priv
= &fake_mlme
;
366 * If the name is a format string the caller wants us to do a
369 if (strchr(dev
->name
, '%')) {
370 err
= dev_alloc_name(dev
, dev
->name
);
375 SET_NETDEV_DEV(dev
, &phy
->dev
);
377 platform_set_drvdata(pdev
, dev
);
379 err
= wpan_phy_register(&pdev
->dev
, phy
);
383 err
= register_netdev(dev
);
387 dev_info(&pdev
->dev
, "Added ieee802154 HardMAC hardware\n");
391 unregister_netdev(dev
);
395 static int __devexit
ieee802154fake_remove(struct platform_device
*pdev
)
397 struct net_device
*dev
= platform_get_drvdata(pdev
);
398 unregister_netdev(dev
);
402 static struct platform_device
*ieee802154fake_dev
;
404 static struct platform_driver ieee802154fake_driver
= {
405 .probe
= ieee802154fake_probe
,
406 .remove
= __devexit_p(ieee802154fake_remove
),
408 .name
= "ieee802154hardmac",
409 .owner
= THIS_MODULE
,
413 static __init
int fake_init(void)
415 ieee802154fake_dev
= platform_device_register_simple(
416 "ieee802154hardmac", -1, NULL
, 0);
417 return platform_driver_register(&ieee802154fake_driver
);
420 static __exit
void fake_exit(void)
422 platform_driver_unregister(&ieee802154fake_driver
);
423 platform_device_unregister(ieee802154fake_dev
);
426 module_init(fake_init
);
427 module_exit(fake_exit
);
428 MODULE_LICENSE("GPL");