2 * Driver for Microchip MRF24J40 802.15.4 Wireless-PAN Networking controller
4 * Copyright (C) 2012 Alan Ott <alan@signal11.us>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/spi/spi.h>
19 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/regmap.h>
22 #include <linux/ieee802154.h>
23 #include <net/cfg802154.h>
24 #include <net/mac802154.h>
26 /* MRF24J40 Short Address Registers */
27 #define REG_RXMCR 0x00 /* Receive MAC control */
28 #define REG_PANIDL 0x01 /* PAN ID (low) */
29 #define REG_PANIDH 0x02 /* PAN ID (high) */
30 #define REG_SADRL 0x03 /* Short address (low) */
31 #define REG_SADRH 0x04 /* Short address (high) */
32 #define REG_EADR0 0x05 /* Long address (low) (high is EADR7) */
33 #define REG_EADR1 0x06
34 #define REG_EADR2 0x07
35 #define REG_EADR3 0x08
36 #define REG_EADR4 0x09
37 #define REG_EADR5 0x0A
38 #define REG_EADR6 0x0B
39 #define REG_EADR7 0x0C
40 #define REG_RXFLUSH 0x0D
41 #define REG_ORDER 0x10
42 #define REG_TXMCR 0x11 /* Transmit MAC control */
43 #define REG_ACKTMOUT 0x12
44 #define REG_ESLOTG1 0x13
45 #define REG_SYMTICKL 0x14
46 #define REG_SYMTICKH 0x15
47 #define REG_PACON0 0x16 /* Power Amplifier Control */
48 #define REG_PACON1 0x17 /* Power Amplifier Control */
49 #define REG_PACON2 0x18 /* Power Amplifier Control */
50 #define REG_TXBCON0 0x1A
51 #define REG_TXNCON 0x1B /* Transmit Normal FIFO Control */
52 #define REG_TXG1CON 0x1C
53 #define REG_TXG2CON 0x1D
54 #define REG_ESLOTG23 0x1E
55 #define REG_ESLOTG45 0x1F
56 #define REG_ESLOTG67 0x20
57 #define REG_TXPEND 0x21
58 #define REG_WAKECON 0x22
59 #define REG_FROMOFFSET 0x23
60 #define REG_TXSTAT 0x24 /* TX MAC Status Register */
61 #define REG_TXBCON1 0x25
62 #define REG_GATECLK 0x26
63 #define REG_TXTIME 0x27
64 #define REG_HSYMTMRL 0x28
65 #define REG_HSYMTMRH 0x29
66 #define REG_SOFTRST 0x2A /* Soft Reset */
67 #define REG_SECCON0 0x2C
68 #define REG_SECCON1 0x2D
69 #define REG_TXSTBL 0x2E /* TX Stabilization */
71 #define REG_INTSTAT 0x31 /* Interrupt Status */
72 #define REG_INTCON 0x32 /* Interrupt Control */
73 #define REG_GPIO 0x33 /* GPIO */
74 #define REG_TRISGPIO 0x34 /* GPIO direction */
75 #define REG_SLPACK 0x35
76 #define REG_RFCTL 0x36 /* RF Control Mode Register */
77 #define REG_SECCR2 0x37
78 #define REG_BBREG0 0x38
79 #define REG_BBREG1 0x39 /* Baseband Registers */
80 #define REG_BBREG2 0x3A /* */
81 #define REG_BBREG3 0x3B
82 #define REG_BBREG4 0x3C
83 #define REG_BBREG6 0x3E /* */
84 #define REG_CCAEDTH 0x3F /* Energy Detection Threshold */
86 /* MRF24J40 Long Address Registers */
87 #define REG_RFCON0 0x200 /* RF Control Registers */
88 #define REG_RFCON1 0x201
89 #define REG_RFCON2 0x202
90 #define REG_RFCON3 0x203
91 #define REG_RFCON5 0x205
92 #define REG_RFCON6 0x206
93 #define REG_RFCON7 0x207
94 #define REG_RFCON8 0x208
95 #define REG_SLPCAL0 0x209
96 #define REG_SLPCAL1 0x20A
97 #define REG_SLPCAL2 0x20B
98 #define REG_RFSTATE 0x20F
99 #define REG_RSSI 0x210
100 #define REG_SLPCON0 0x211 /* Sleep Clock Control Registers */
101 #define REG_SLPCON1 0x220
102 #define REG_WAKETIMEL 0x222 /* Wake-up Time Match Value Low */
103 #define REG_WAKETIMEH 0x223 /* Wake-up Time Match Value High */
104 #define REG_REMCNTL 0x224
105 #define REG_REMCNTH 0x225
106 #define REG_MAINCNT0 0x226
107 #define REG_MAINCNT1 0x227
108 #define REG_MAINCNT2 0x228
109 #define REG_MAINCNT3 0x229
110 #define REG_TESTMODE 0x22F /* Test mode */
111 #define REG_ASSOEAR0 0x230
112 #define REG_ASSOEAR1 0x231
113 #define REG_ASSOEAR2 0x232
114 #define REG_ASSOEAR3 0x233
115 #define REG_ASSOEAR4 0x234
116 #define REG_ASSOEAR5 0x235
117 #define REG_ASSOEAR6 0x236
118 #define REG_ASSOEAR7 0x237
119 #define REG_ASSOSAR0 0x238
120 #define REG_ASSOSAR1 0x239
121 #define REG_UNONCE0 0x240
122 #define REG_UNONCE1 0x241
123 #define REG_UNONCE2 0x242
124 #define REG_UNONCE3 0x243
125 #define REG_UNONCE4 0x244
126 #define REG_UNONCE5 0x245
127 #define REG_UNONCE6 0x246
128 #define REG_UNONCE7 0x247
129 #define REG_UNONCE8 0x248
130 #define REG_UNONCE9 0x249
131 #define REG_UNONCE10 0x24A
132 #define REG_UNONCE11 0x24B
133 #define REG_UNONCE12 0x24C
134 #define REG_RX_FIFO 0x300 /* Receive FIFO */
136 /* Device configuration: Only channels 11-26 on page 0 are supported. */
137 #define MRF24J40_CHAN_MIN 11
138 #define MRF24J40_CHAN_MAX 26
139 #define CHANNEL_MASK (((u32)1 << (MRF24J40_CHAN_MAX + 1)) \
140 - ((u32)1 << MRF24J40_CHAN_MIN))
142 #define TX_FIFO_SIZE 128 /* From datasheet */
143 #define RX_FIFO_SIZE 144 /* From datasheet */
144 #define SET_CHANNEL_DELAY_US 192 /* From datasheet */
146 enum mrf24j40_modules { MRF24J40, MRF24J40MA, MRF24J40MC };
148 /* Device Private Data */
150 struct spi_device *spi;
151 struct ieee802154_hw *hw;
153 struct regmap *regmap_short;
154 struct regmap *regmap_long;
156 /* for writing txfifo */
157 struct spi_message tx_msg;
159 struct spi_transfer tx_hdr_trx;
161 struct spi_transfer tx_len_trx;
162 struct spi_transfer tx_buf_trx;
163 struct sk_buff *tx_skb;
165 /* post transmit message to send frame out */
166 struct spi_message tx_post_msg;
168 struct spi_transfer tx_post_trx;
170 /* for protect/unprotect/read length rxfifo */
171 struct spi_message rx_msg;
173 struct spi_transfer rx_trx;
175 /* receive handling */
176 struct spi_message rx_buf_msg;
178 struct spi_transfer rx_addr_trx;
180 struct spi_transfer rx_lqi_trx;
181 u8 rx_fifo_buf[RX_FIFO_SIZE];
182 struct spi_transfer rx_fifo_buf_trx;
184 /* isr handling for reading intstat */
185 struct spi_message irq_msg;
187 struct spi_transfer irq_trx;
190 /* regmap information for short address register access */
191 #define MRF24J40_SHORT_WRITE 0x01
192 #define MRF24J40_SHORT_READ 0x00
193 #define MRF24J40_SHORT_NUMREGS 0x3F
195 /* regmap information for long address register access */
196 #define MRF24J40_LONG_ACCESS 0x80
197 #define MRF24J40_LONG_NUMREGS 0x38F
199 /* Read/Write SPI Commands for Short and Long Address registers. */
200 #define MRF24J40_READSHORT(reg) ((reg) << 1)
201 #define MRF24J40_WRITESHORT(reg) ((reg) << 1 | 1)
202 #define MRF24J40_READLONG(reg) (1 << 15 | (reg) << 5)
203 #define MRF24J40_WRITELONG(reg) (1 << 15 | (reg) << 5 | 1 << 4)
205 /* The datasheet indicates the theoretical maximum for SCK to be 10MHz */
206 #define MAX_SPI_SPEED_HZ 10000000
208 #define printdev(X) (&X->spi->dev)
211 mrf24j40_short_reg_writeable(struct device *dev, unsigned int reg)
276 mrf24j40_short_reg_readable(struct device *dev, unsigned int reg)
280 /* all writeable are also readable */
281 rc = mrf24j40_short_reg_writeable(dev, reg);
296 mrf24j40_short_reg_volatile(struct device *dev, unsigned int reg)
298 /* can be changed during runtime */
315 /* use them in spi_async and regmap so it's volatile */
324 mrf24j40_short_reg_precious(struct device *dev, unsigned int reg)
326 /* don't clear irq line on read */
335 static const struct regmap_config mrf24j40_short_regmap = {
336 .name = "mrf24j40_short",
340 .write_flag_mask = MRF24J40_SHORT_WRITE,
341 .read_flag_mask = MRF24J40_SHORT_READ,
342 .cache_type = REGCACHE_RBTREE,
343 .max_register = MRF24J40_SHORT_NUMREGS,
344 .writeable_reg = mrf24j40_short_reg_writeable,
345 .readable_reg = mrf24j40_short_reg_readable,
346 .volatile_reg = mrf24j40_short_reg_volatile,
347 .precious_reg = mrf24j40_short_reg_precious,
351 mrf24j40_long_reg_writeable(struct device *dev, unsigned int reg)
404 mrf24j40_long_reg_readable(struct device *dev, unsigned int reg)
408 /* all writeable are also readable */
409 rc = mrf24j40_long_reg_writeable(dev, reg);
426 mrf24j40_long_reg_volatile(struct device *dev, unsigned int reg)
428 /* can be changed during runtime */
442 static const struct regmap_config mrf24j40_long_regmap = {
443 .name = "mrf24j40_long",
447 .write_flag_mask = MRF24J40_LONG_ACCESS,
448 .read_flag_mask = MRF24J40_LONG_ACCESS,
449 .cache_type = REGCACHE_RBTREE,
450 .max_register = MRF24J40_LONG_NUMREGS,
451 .writeable_reg = mrf24j40_long_reg_writeable,
452 .readable_reg = mrf24j40_long_reg_readable,
453 .volatile_reg = mrf24j40_long_reg_volatile,
456 static int mrf24j40_long_regmap_write(void *context, const void *data,
459 struct spi_device *spi = context;
465 /* regmap supports read/write mask only in frist byte
466 * long write access need to set the 12th bit, so we
467 * make special handling for write.
469 memcpy(buf, data, count);
472 return spi_write(spi, buf, count);
476 mrf24j40_long_regmap_read(void *context, const void *reg, size_t reg_size,
477 void *val, size_t val_size)
479 struct spi_device *spi = context;
481 return spi_write_then_read(spi, reg, reg_size, val, val_size);
484 static const struct regmap_bus mrf24j40_long_regmap_bus = {
485 .write = mrf24j40_long_regmap_write,
486 .read = mrf24j40_long_regmap_read,
487 .reg_format_endian_default = REGMAP_ENDIAN_BIG,
488 .val_format_endian_default = REGMAP_ENDIAN_BIG,
491 static void write_tx_buf_complete(void *context)
493 struct mrf24j40 *devrec = context;
494 __le16 fc = ieee802154_get_fc_from_skb(devrec->tx_skb);
498 if (ieee802154_is_ackreq(fc))
501 devrec->tx_post_msg.complete = NULL;
502 devrec->tx_post_buf[0] = MRF24J40_WRITESHORT(REG_TXNCON);
503 devrec->tx_post_buf[1] = val;
505 ret = spi_async(devrec->spi, &devrec->tx_post_msg);
507 dev_err(printdev(devrec), "SPI write Failed for transmit buf\n");
510 /* This function relies on an undocumented write method. Once a write command
511 and address is set, as many bytes of data as desired can be clocked into
512 the device. The datasheet only shows setting one byte at a time. */
513 static int write_tx_buf(struct mrf24j40 *devrec, u16 reg,
514 const u8 *data, size_t length)
519 /* Range check the length. 2 bytes are used for the length fields.*/
520 if (length > TX_FIFO_SIZE-2) {
521 dev_err(printdev(devrec), "write_tx_buf() was passed too large a buffer. Performing short write.\n");
522 length = TX_FIFO_SIZE-2;
525 cmd = MRF24J40_WRITELONG(reg);
526 devrec->tx_hdr_buf[0] = cmd >> 8 & 0xff;
527 devrec->tx_hdr_buf[1] = cmd & 0xff;
528 devrec->tx_len_buf[0] = 0x0; /* Header Length. Set to 0 for now. TODO */
529 devrec->tx_len_buf[1] = length; /* Total length */
530 devrec->tx_buf_trx.tx_buf = data;
531 devrec->tx_buf_trx.len = length;
533 ret = spi_async(devrec->spi, &devrec->tx_msg);
535 dev_err(printdev(devrec), "SPI write Failed for TX buf\n");
540 static int mrf24j40_tx(struct ieee802154_hw *hw, struct sk_buff *skb)
542 struct mrf24j40 *devrec = hw->priv;
544 dev_dbg(printdev(devrec), "tx packet of %d bytes\n", skb->len);
545 devrec->tx_skb = skb;
547 return write_tx_buf(devrec, 0x000, skb->data, skb->len);
550 static int mrf24j40_ed(struct ieee802154_hw *hw, u8 *level)
553 pr_warn("mrf24j40: ed not implemented\n");
558 static int mrf24j40_start(struct ieee802154_hw *hw)
560 struct mrf24j40 *devrec = hw->priv;
562 dev_dbg(printdev(devrec), "start\n");
564 /* Clear TXNIE and RXIE. Enable interrupts */
565 return regmap_update_bits(devrec->regmap_short, REG_INTCON,
569 static void mrf24j40_stop(struct ieee802154_hw *hw)
571 struct mrf24j40 *devrec = hw->priv;
573 dev_dbg(printdev(devrec), "stop\n");
575 /* Set TXNIE and RXIE. Disable Interrupts */
576 regmap_update_bits(devrec->regmap_short, REG_INTCON, 0x01 | 0x08,
580 static int mrf24j40_set_channel(struct ieee802154_hw *hw, u8 page, u8 channel)
582 struct mrf24j40 *devrec = hw->priv;
586 dev_dbg(printdev(devrec), "Set Channel %d\n", channel);
589 WARN_ON(channel < MRF24J40_CHAN_MIN);
590 WARN_ON(channel > MRF24J40_CHAN_MAX);
592 /* Set Channel TODO */
593 val = (channel-11) << 4 | 0x03;
594 ret = regmap_update_bits(devrec->regmap_long, REG_RFCON0, 0xf0, val);
599 ret = regmap_update_bits(devrec->regmap_short, REG_RFCTL, 0x04, 0x04);
603 ret = regmap_update_bits(devrec->regmap_short, REG_RFCTL, 0x04, 0x00);
605 udelay(SET_CHANNEL_DELAY_US); /* per datasheet */
610 static int mrf24j40_filter(struct ieee802154_hw *hw,
611 struct ieee802154_hw_addr_filt *filt,
612 unsigned long changed)
614 struct mrf24j40 *devrec = hw->priv;
616 dev_dbg(printdev(devrec), "filter\n");
618 if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
622 addrh = le16_to_cpu(filt->short_addr) >> 8 & 0xff;
623 addrl = le16_to_cpu(filt->short_addr) & 0xff;
625 regmap_write(devrec->regmap_short, REG_SADRH, addrh);
626 regmap_write(devrec->regmap_short, REG_SADRL, addrl);
627 dev_dbg(printdev(devrec),
628 "Set short addr to %04hx\n", filt->short_addr);
631 if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
635 memcpy(addr, &filt->ieee_addr, 8);
636 for (i = 0; i < 8; i++)
637 regmap_write(devrec->regmap_short, REG_EADR0 + i,
641 pr_debug("Set long addr to: ");
642 for (i = 0; i < 8; i++)
643 pr_debug("%02hhx ", addr[7 - i]);
648 if (changed & IEEE802154_AFILT_PANID_CHANGED) {
652 panidh = le16_to_cpu(filt->pan_id) >> 8 & 0xff;
653 panidl = le16_to_cpu(filt->pan_id) & 0xff;
654 regmap_write(devrec->regmap_short, REG_PANIDH, panidh);
655 regmap_write(devrec->regmap_short, REG_PANIDL, panidl);
657 dev_dbg(printdev(devrec), "Set PANID to %04hx\n", filt->pan_id);
660 if (changed & IEEE802154_AFILT_PANC_CHANGED) {
661 /* Pan Coordinator */
669 ret = regmap_update_bits(devrec->regmap_short, REG_RXMCR, 0x8,
674 /* REG_SLOTTED is maintained as default (unslotted/CSMA-CA).
675 * REG_ORDER is maintained as default (no beacon/superframe).
678 dev_dbg(printdev(devrec), "Set Pan Coord to %s\n",
679 filt->pan_coord ? "on" : "off");
685 static void mrf24j40_handle_rx_read_buf_unlock(struct mrf24j40 *devrec)
689 /* Turn back on reception of packets off the air. */
690 devrec->rx_msg.complete = NULL;
691 devrec->rx_buf[0] = MRF24J40_WRITESHORT(REG_BBREG1);
692 devrec->rx_buf[1] = 0x00; /* CLR RXDECINV */
693 ret = spi_async(devrec->spi, &devrec->rx_msg);
695 dev_err(printdev(devrec), "failed to unlock rx buffer\n");
698 static void mrf24j40_handle_rx_read_buf_complete(void *context)
700 struct mrf24j40 *devrec = context;
701 u8 len = devrec->rx_buf[2];
702 u8 rx_local_buf[RX_FIFO_SIZE];
705 memcpy(rx_local_buf, devrec->rx_fifo_buf, len);
706 mrf24j40_handle_rx_read_buf_unlock(devrec);
708 skb = dev_alloc_skb(IEEE802154_MTU);
710 dev_err(printdev(devrec), "failed to allocate skb\n");
714 memcpy(skb_put(skb, len), rx_local_buf, len);
715 ieee802154_rx_irqsafe(devrec->hw, skb, 0);
718 print_hex_dump(KERN_DEBUG, "mrf24j40 rx: ", DUMP_PREFIX_OFFSET, 16, 1,
719 rx_local_buf, len, 0);
720 pr_debug("mrf24j40 rx: lqi: %02hhx rssi: %02hhx\n",
721 devrec->rx_lqi_buf[0], devrec->rx_lqi_buf[1]);
725 static void mrf24j40_handle_rx_read_buf(void *context)
727 struct mrf24j40 *devrec = context;
731 /* if length is invalid read the full MTU */
732 if (!ieee802154_is_valid_psdu_len(devrec->rx_buf[2]))
733 devrec->rx_buf[2] = IEEE802154_MTU;
735 cmd = MRF24J40_READLONG(REG_RX_FIFO + 1);
736 devrec->rx_addr_buf[0] = cmd >> 8 & 0xff;
737 devrec->rx_addr_buf[1] = cmd & 0xff;
738 devrec->rx_fifo_buf_trx.len = devrec->rx_buf[2];
739 ret = spi_async(devrec->spi, &devrec->rx_buf_msg);
741 dev_err(printdev(devrec), "failed to read rx buffer\n");
742 mrf24j40_handle_rx_read_buf_unlock(devrec);
746 static void mrf24j40_handle_rx_read_len(void *context)
748 struct mrf24j40 *devrec = context;
752 /* read the length of received frame */
753 devrec->rx_msg.complete = mrf24j40_handle_rx_read_buf;
754 devrec->rx_trx.len = 3;
755 cmd = MRF24J40_READLONG(REG_RX_FIFO);
756 devrec->rx_buf[0] = cmd >> 8 & 0xff;
757 devrec->rx_buf[1] = cmd & 0xff;
759 ret = spi_async(devrec->spi, &devrec->rx_msg);
761 dev_err(printdev(devrec), "failed to read rx buffer length\n");
762 mrf24j40_handle_rx_read_buf_unlock(devrec);
766 static int mrf24j40_handle_rx(struct mrf24j40 *devrec)
768 /* Turn off reception of packets off the air. This prevents the
769 * device from overwriting the buffer while we're reading it.
771 devrec->rx_msg.complete = mrf24j40_handle_rx_read_len;
772 devrec->rx_trx.len = 2;
773 devrec->rx_buf[0] = MRF24J40_WRITESHORT(REG_BBREG1);
774 devrec->rx_buf[1] = 0x04; /* SET RXDECINV */
776 return spi_async(devrec->spi, &devrec->rx_msg);
780 mrf24j40_csma_params(struct ieee802154_hw *hw, u8 min_be, u8 max_be,
783 struct mrf24j40 *devrec = hw->priv;
791 return regmap_update_bits(devrec->regmap_short, REG_TXMCR, 0x1f, val);
794 static int mrf24j40_set_cca_mode(struct ieee802154_hw *hw,
795 const struct wpan_phy_cca *cca)
797 struct mrf24j40 *devrec = hw->priv;
800 /* mapping 802.15.4 to driver spec */
802 case NL802154_CCA_ENERGY:
805 case NL802154_CCA_CARRIER:
808 case NL802154_CCA_ENERGY_CARRIER:
810 case NL802154_CCA_OPT_ENERGY_CARRIER_AND:
821 return regmap_update_bits(devrec->regmap_short, REG_BBREG2, 0xc0,
825 /* array for representing ed levels */
826 static const s32 mrf24j40_ed_levels[] = {
827 -9000, -8900, -8800, -8700, -8600, -8500, -8400, -8300, -8200, -8100,
828 -8000, -7900, -7800, -7700, -7600, -7500, -7400, -7300, -7200, -7100,
829 -7000, -6900, -6800, -6700, -6600, -6500, -6400, -6300, -6200, -6100,
830 -6000, -5900, -5800, -5700, -5600, -5500, -5400, -5300, -5200, -5100,
831 -5000, -4900, -4800, -4700, -4600, -4500, -4400, -4300, -4200, -4100,
832 -4000, -3900, -3800, -3700, -3600, -3500
835 /* map ed levels to register value */
836 static const s32 mrf24j40_ed_levels_map[][2] = {
837 { -9000, 0 }, { -8900, 1 }, { -8800, 2 }, { -8700, 5 }, { -8600, 9 },
838 { -8500, 13 }, { -8400, 18 }, { -8300, 23 }, { -8200, 27 },
839 { -8100, 32 }, { -8000, 37 }, { -7900, 43 }, { -7800, 48 },
840 { -7700, 53 }, { -7600, 58 }, { -7500, 63 }, { -7400, 68 },
841 { -7300, 73 }, { -7200, 78 }, { -7100, 83 }, { -7000, 89 },
842 { -6900, 95 }, { -6800, 100 }, { -6700, 107 }, { -6600, 111 },
843 { -6500, 117 }, { -6400, 121 }, { -6300, 125 }, { -6200, 129 },
844 { -6100, 133 }, { -6000, 138 }, { -5900, 143 }, { -5800, 148 },
845 { -5700, 153 }, { -5600, 159 }, { -5500, 165 }, { -5400, 170 },
846 { -5300, 176 }, { -5200, 183 }, { -5100, 188 }, { -5000, 193 },
847 { -4900, 198 }, { -4800, 203 }, { -4700, 207 }, { -4600, 212 },
848 { -4500, 216 }, { -4400, 221 }, { -4300, 225 }, { -4200, 228 },
849 { -4100, 233 }, { -4000, 239 }, { -3900, 245 }, { -3800, 250 },
850 { -3700, 253 }, { -3600, 254 }, { -3500, 255 },
853 static int mrf24j40_set_cca_ed_level(struct ieee802154_hw *hw, s32 mbm)
855 struct mrf24j40 *devrec = hw->priv;
858 for (i = 0; i < ARRAY_SIZE(mrf24j40_ed_levels_map); i++) {
859 if (mrf24j40_ed_levels_map[i][0] == mbm)
860 return regmap_write(devrec->regmap_short, REG_CCAEDTH,
861 mrf24j40_ed_levels_map[i][1]);
867 static const s32 mrf24j40ma_powers[] = {
868 0, -50, -120, -190, -280, -370, -490, -630, -1000, -1050, -1120, -1190,
869 -1280, -1370, -1490, -1630, -2000, -2050, -2120, -2190, -2280, -2370,
870 -2490, -2630, -3000, -3050, -3120, -3190, -3280, -3370, -3490, -3630,
873 static int mrf24j40_set_txpower(struct ieee802154_hw *hw, s32 mbm)
875 struct mrf24j40 *devrec = hw->priv;
879 if (0 >= mbm && mbm > -1000) {
882 } else if (-1000 >= mbm && mbm > -2000) {
884 small_scale = mbm + 1000;
885 } else if (-2000 >= mbm && mbm > -3000) {
887 small_scale = mbm + 2000;
888 } else if (-3000 >= mbm && mbm > -4000) {
890 small_scale = mbm + 3000;
895 switch (small_scale) {
923 return regmap_update_bits(devrec->regmap_long, REG_RFCON3, 0xf8, val);
926 static int mrf24j40_set_promiscuous_mode(struct ieee802154_hw *hw, bool on)
928 struct mrf24j40 *devrec = hw->priv;
932 /* set PROMI, ERRPKT and NOACKRSP */
933 ret = regmap_update_bits(devrec->regmap_short, REG_RXMCR, 0x23,
936 /* clear PROMI, ERRPKT and NOACKRSP */
937 ret = regmap_update_bits(devrec->regmap_short, REG_RXMCR, 0x23,
944 static const struct ieee802154_ops mrf24j40_ops = {
945 .owner = THIS_MODULE,
946 .xmit_async = mrf24j40_tx,
948 .start = mrf24j40_start,
949 .stop = mrf24j40_stop,
950 .set_channel = mrf24j40_set_channel,
951 .set_hw_addr_filt = mrf24j40_filter,
952 .set_csma_params = mrf24j40_csma_params,
953 .set_cca_mode = mrf24j40_set_cca_mode,
954 .set_cca_ed_level = mrf24j40_set_cca_ed_level,
955 .set_txpower = mrf24j40_set_txpower,
956 .set_promiscuous_mode = mrf24j40_set_promiscuous_mode,
959 static void mrf24j40_intstat_complete(void *context)
961 struct mrf24j40 *devrec = context;
962 u8 intstat = devrec->irq_buf[1];
964 enable_irq(devrec->spi->irq);
966 /* Check for TX complete */
968 ieee802154_xmit_complete(devrec->hw, devrec->tx_skb, false);
972 mrf24j40_handle_rx(devrec);
975 static irqreturn_t mrf24j40_isr(int irq, void *data)
977 struct mrf24j40 *devrec = data;
980 disable_irq_nosync(irq);
982 devrec->irq_buf[0] = MRF24J40_READSHORT(REG_INTSTAT);
983 /* Read the interrupt status */
984 ret = spi_async(devrec->spi, &devrec->irq_msg);
993 static int mrf24j40_hw_init(struct mrf24j40 *devrec)
997 /* Initialize the device.
998 From datasheet section 3.2: Initialization. */
999 ret = regmap_write(devrec->regmap_short, REG_SOFTRST, 0x07);
1003 ret = regmap_write(devrec->regmap_short, REG_PACON2, 0x98);
1007 ret = regmap_write(devrec->regmap_short, REG_TXSTBL, 0x95);
1011 ret = regmap_write(devrec->regmap_long, REG_RFCON0, 0x03);
1015 ret = regmap_write(devrec->regmap_long, REG_RFCON1, 0x01);
1019 ret = regmap_write(devrec->regmap_long, REG_RFCON2, 0x80);
1023 ret = regmap_write(devrec->regmap_long, REG_RFCON6, 0x90);
1027 ret = regmap_write(devrec->regmap_long, REG_RFCON7, 0x80);
1031 ret = regmap_write(devrec->regmap_long, REG_RFCON8, 0x10);
1035 ret = regmap_write(devrec->regmap_long, REG_SLPCON1, 0x21);
1039 ret = regmap_write(devrec->regmap_short, REG_BBREG2, 0x80);
1043 ret = regmap_write(devrec->regmap_short, REG_CCAEDTH, 0x60);
1047 ret = regmap_write(devrec->regmap_short, REG_BBREG6, 0x40);
1051 ret = regmap_write(devrec->regmap_short, REG_RFCTL, 0x04);
1055 ret = regmap_write(devrec->regmap_short, REG_RFCTL, 0x0);
1061 /* Set RX Mode. RXMCR<1:0>: 0x0 normal, 0x1 promisc, 0x2 error */
1062 ret = regmap_update_bits(devrec->regmap_short, REG_RXMCR, 0x03, 0x00);
1066 if (spi_get_device_id(devrec->spi)->driver_data == MRF24J40MC) {
1067 /* Enable external amplifier.
1068 * From MRF24J40MC datasheet section 1.3: Operation.
1070 regmap_update_bits(devrec->regmap_long, REG_TESTMODE, 0x07,
1073 /* Set GPIO3 as output. */
1074 regmap_update_bits(devrec->regmap_short, REG_TRISGPIO, 0x08,
1077 /* Set GPIO3 HIGH to enable U5 voltage regulator */
1078 regmap_update_bits(devrec->regmap_short, REG_GPIO, 0x08, 0x08);
1080 /* Reduce TX pwr to meet FCC requirements.
1081 * From MRF24J40MC datasheet section 3.1.1
1083 regmap_write(devrec->regmap_long, REG_RFCON3, 0x28);
1093 mrf24j40_setup_tx_spi_messages(struct mrf24j40 *devrec)
1095 spi_message_init(&devrec->tx_msg);
1096 devrec->tx_msg.context = devrec;
1097 devrec->tx_msg.complete = write_tx_buf_complete;
1098 devrec->tx_hdr_trx.len = 2;
1099 devrec->tx_hdr_trx.tx_buf = devrec->tx_hdr_buf;
1100 spi_message_add_tail(&devrec->tx_hdr_trx, &devrec->tx_msg);
1101 devrec->tx_len_trx.len = 2;
1102 devrec->tx_len_trx.tx_buf = devrec->tx_len_buf;
1103 spi_message_add_tail(&devrec->tx_len_trx, &devrec->tx_msg);
1104 spi_message_add_tail(&devrec->tx_buf_trx, &devrec->tx_msg);
1106 spi_message_init(&devrec->tx_post_msg);
1107 devrec->tx_post_msg.context = devrec;
1108 devrec->tx_post_trx.len = 2;
1109 devrec->tx_post_trx.tx_buf = devrec->tx_post_buf;
1110 spi_message_add_tail(&devrec->tx_post_trx, &devrec->tx_post_msg);
1114 mrf24j40_setup_rx_spi_messages(struct mrf24j40 *devrec)
1116 spi_message_init(&devrec->rx_msg);
1117 devrec->rx_msg.context = devrec;
1118 devrec->rx_trx.len = 2;
1119 devrec->rx_trx.tx_buf = devrec->rx_buf;
1120 devrec->rx_trx.rx_buf = devrec->rx_buf;
1121 spi_message_add_tail(&devrec->rx_trx, &devrec->rx_msg);
1123 spi_message_init(&devrec->rx_buf_msg);
1124 devrec->rx_buf_msg.context = devrec;
1125 devrec->rx_buf_msg.complete = mrf24j40_handle_rx_read_buf_complete;
1126 devrec->rx_addr_trx.len = 2;
1127 devrec->rx_addr_trx.tx_buf = devrec->rx_addr_buf;
1128 spi_message_add_tail(&devrec->rx_addr_trx, &devrec->rx_buf_msg);
1129 devrec->rx_fifo_buf_trx.rx_buf = devrec->rx_fifo_buf;
1130 spi_message_add_tail(&devrec->rx_fifo_buf_trx, &devrec->rx_buf_msg);
1131 devrec->rx_lqi_trx.len = 2;
1132 devrec->rx_lqi_trx.rx_buf = devrec->rx_lqi_buf;
1133 spi_message_add_tail(&devrec->rx_lqi_trx, &devrec->rx_buf_msg);
1137 mrf24j40_setup_irq_spi_messages(struct mrf24j40 *devrec)
1139 spi_message_init(&devrec->irq_msg);
1140 devrec->irq_msg.context = devrec;
1141 devrec->irq_msg.complete = mrf24j40_intstat_complete;
1142 devrec->irq_trx.len = 2;
1143 devrec->irq_trx.tx_buf = devrec->irq_buf;
1144 devrec->irq_trx.rx_buf = devrec->irq_buf;
1145 spi_message_add_tail(&devrec->irq_trx, &devrec->irq_msg);
1148 static void mrf24j40_phy_setup(struct mrf24j40 *devrec)
1150 ieee802154_random_extended_addr(&devrec->hw->phy->perm_extended_addr);
1151 devrec->hw->phy->current_channel = 11;
1153 /* mrf24j40 supports max_minbe 0 - 3 */
1154 devrec->hw->phy->supported.max_minbe = 3;
1155 /* datasheet doesn't say anything about max_be, but we have min_be
1156 * So we assume the max_be default.
1158 devrec->hw->phy->supported.min_maxbe = 5;
1159 devrec->hw->phy->supported.max_maxbe = 5;
1161 devrec->hw->phy->cca.mode = NL802154_CCA_CARRIER;;
1162 devrec->hw->phy->supported.cca_modes = BIT(NL802154_CCA_ENERGY) |
1163 BIT(NL802154_CCA_CARRIER) |
1164 BIT(NL802154_CCA_ENERGY_CARRIER);
1165 devrec->hw->phy->supported.cca_opts = BIT(NL802154_CCA_OPT_ENERGY_CARRIER_AND);
1167 devrec->hw->phy->cca_ed_level = -6900;
1168 devrec->hw->phy->supported.cca_ed_levels = mrf24j40_ed_levels;
1169 devrec->hw->phy->supported.cca_ed_levels_size = ARRAY_SIZE(mrf24j40_ed_levels);
1171 switch (spi_get_device_id(devrec->spi)->driver_data) {
1174 devrec->hw->phy->supported.tx_powers = mrf24j40ma_powers;
1175 devrec->hw->phy->supported.tx_powers_size = ARRAY_SIZE(mrf24j40ma_powers);
1176 devrec->hw->phy->flags |= WPAN_PHY_FLAG_TXPOWER;
1183 static int mrf24j40_probe(struct spi_device *spi)
1186 struct ieee802154_hw *hw;
1187 struct mrf24j40 *devrec;
1189 dev_info(&spi->dev, "probe(). IRQ: %d\n", spi->irq);
1191 /* Register with the 802154 subsystem */
1193 hw = ieee802154_alloc_hw(sizeof(*devrec), &mrf24j40_ops);
1199 spi_set_drvdata(spi, devrec);
1201 devrec->hw->parent = &spi->dev;
1202 devrec->hw->phy->supported.channels[0] = CHANNEL_MASK;
1203 devrec->hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_AFILT |
1204 IEEE802154_HW_CSMA_PARAMS |
1205 IEEE802154_HW_PROMISCUOUS;
1207 devrec->hw->phy->flags = WPAN_PHY_FLAG_CCA_MODE |
1208 WPAN_PHY_FLAG_CCA_ED_LEVEL;
1210 mrf24j40_setup_tx_spi_messages(devrec);
1211 mrf24j40_setup_rx_spi_messages(devrec);
1212 mrf24j40_setup_irq_spi_messages(devrec);
1214 devrec->regmap_short = devm_regmap_init_spi(spi,
1215 &mrf24j40_short_regmap);
1216 if (IS_ERR(devrec->regmap_short)) {
1217 ret = PTR_ERR(devrec->regmap_short);
1218 dev_err(&spi->dev, "Failed to allocate short register map: %d\n",
1220 goto err_register_device;
1223 devrec->regmap_long = devm_regmap_init(&spi->dev,
1224 &mrf24j40_long_regmap_bus,
1225 spi, &mrf24j40_long_regmap);
1226 if (IS_ERR(devrec->regmap_long)) {
1227 ret = PTR_ERR(devrec->regmap_long);
1228 dev_err(&spi->dev, "Failed to allocate long register map: %d\n",
1230 goto err_register_device;
1233 if (spi->max_speed_hz > MAX_SPI_SPEED_HZ) {
1234 dev_warn(&spi->dev, "spi clock above possible maximum: %d",
1239 ret = mrf24j40_hw_init(devrec);
1241 goto err_register_device;
1243 mrf24j40_phy_setup(devrec);
1245 ret = devm_request_irq(&spi->dev, spi->irq, mrf24j40_isr,
1246 IRQF_TRIGGER_LOW, dev_name(&spi->dev),
1249 dev_err(printdev(devrec), "Unable to get IRQ");
1250 goto err_register_device;
1253 dev_dbg(printdev(devrec), "registered mrf24j40\n");
1254 ret = ieee802154_register_hw(devrec->hw);
1256 goto err_register_device;
1260 err_register_device:
1261 ieee802154_free_hw(devrec->hw);
1266 static int mrf24j40_remove(struct spi_device *spi)
1268 struct mrf24j40 *devrec = spi_get_drvdata(spi);
1270 dev_dbg(printdev(devrec), "remove\n");
1272 ieee802154_unregister_hw(devrec->hw);
1273 ieee802154_free_hw(devrec->hw);
1274 /* TODO: Will ieee802154_free_device() wait until ->xmit() is
1280 static const struct of_device_id mrf24j40_of_match[] = {
1281 { .compatible = "microchip,mrf24j40", .data = (void *)MRF24J40 },
1282 { .compatible = "microchip,mrf24j40ma", .data = (void *)MRF24J40MA },
1283 { .compatible = "microchip,mrf24j40mc", .data = (void *)MRF24J40MC },
1286 MODULE_DEVICE_TABLE(of, mrf24j40_of_match);
1288 static const struct spi_device_id mrf24j40_ids[] = {
1289 { "mrf24j40", MRF24J40 },
1290 { "mrf24j40ma", MRF24J40MA },
1291 { "mrf24j40mc", MRF24J40MC },
1294 MODULE_DEVICE_TABLE(spi, mrf24j40_ids);
1296 static struct spi_driver mrf24j40_driver = {
1298 .of_match_table = of_match_ptr(mrf24j40_of_match),
1300 .owner = THIS_MODULE,
1302 .id_table = mrf24j40_ids,
1303 .probe = mrf24j40_probe,
1304 .remove = mrf24j40_remove,
1307 module_spi_driver(mrf24j40_driver);
1309 MODULE_LICENSE("GPL");
1310 MODULE_AUTHOR("Alan Ott");
1311 MODULE_DESCRIPTION("MRF24J40 SPI 802.15.4 Controller Driver");