2 * http://www.cascoda.com/products/ca-821x/
3 * Copyright (c) 2016, Cascoda, Ltd.
6 * This code is dual-licensed under both GPLv2 and 3-clause BSD. What follows is
7 * the license notice for both respectively.
9 *******************************************************************************
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 *******************************************************************************
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions are met:
26 * 1. Redistributions of source code must retain the above copyright notice,
27 * this list of conditions and the following disclaimer.
29 * 2. Redistributions in binary form must reproduce the above copyright notice,
30 * this list of conditions and the following disclaimer in the documentation
31 * and/or other materials provided with the distribution.
33 * 3. Neither the name of the copyright holder nor the names of its contributors
34 * may be used to endorse or promote products derived from this software without
35 * specific prior written permission.
37 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
38 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
39 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
40 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
41 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
43 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
44 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
45 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
47 * POSSIBILITY OF SUCH DAMAGE.
50 #include <linux/cdev.h>
51 #include <linux/clk-provider.h>
52 #include <linux/debugfs.h>
53 #include <linux/delay.h>
54 #include <linux/gpio.h>
55 #include <linux/ieee802154.h>
57 #include <linux/kfifo.h>
59 #include <linux/of_device.h>
60 #include <linux/of_gpio.h>
61 #include <linux/module.h>
62 #include <linux/mutex.h>
63 #include <linux/poll.h>
64 #include <linux/skbuff.h>
65 #include <linux/slab.h>
66 #include <linux/spi/spi.h>
67 #include <linux/spinlock.h>
68 #include <linux/string.h>
69 #include <linux/workqueue.h>
70 #include <linux/interrupt.h>
72 #include <net/ieee802154_netdev.h>
73 #include <net/mac802154.h>
75 #define DRIVER_NAME "ca8210"
77 /* external clock frequencies */
78 #define ONE_MHZ 1000000
79 #define TWO_MHZ (2 * ONE_MHZ)
80 #define FOUR_MHZ (4 * ONE_MHZ)
81 #define EIGHT_MHZ (8 * ONE_MHZ)
82 #define SIXTEEN_MHZ (16 * ONE_MHZ)
85 #define CA8210_SPI_BUF_SIZE 256
86 #define CA8210_SYNC_TIMEOUT 1000 /* Timeout for synchronous commands [ms] */
88 /* test interface constants */
89 #define CA8210_TEST_INT_FILE_NAME "ca8210_test"
90 #define CA8210_TEST_INT_FIFO_SIZE 256
92 /* HWME attribute IDs */
93 #define HWME_EDTHRESHOLD (0x04)
94 #define HWME_EDVALUE (0x06)
95 #define HWME_SYSCLKOUT (0x0F)
96 #define HWME_LQILIMIT (0x11)
98 /* TDME attribute IDs */
99 #define TDME_CHANNEL (0x00)
100 #define TDME_ATM_CONFIG (0x06)
102 #define MAX_HWME_ATTRIBUTE_SIZE 16
103 #define MAX_TDME_ATTRIBUTE_SIZE 2
105 /* PHY/MAC PIB Attribute Enumerations */
106 #define PHY_CURRENT_CHANNEL (0x00)
107 #define PHY_TRANSMIT_POWER (0x02)
108 #define PHY_CCA_MODE (0x03)
109 #define MAC_ASSOCIATION_PERMIT (0x41)
110 #define MAC_AUTO_REQUEST (0x42)
111 #define MAC_BATT_LIFE_EXT (0x43)
112 #define MAC_BATT_LIFE_EXT_PERIODS (0x44)
113 #define MAC_BEACON_PAYLOAD (0x45)
114 #define MAC_BEACON_PAYLOAD_LENGTH (0x46)
115 #define MAC_BEACON_ORDER (0x47)
116 #define MAC_GTS_PERMIT (0x4d)
117 #define MAC_MAX_CSMA_BACKOFFS (0x4e)
118 #define MAC_MIN_BE (0x4f)
119 #define MAC_PAN_ID (0x50)
120 #define MAC_PROMISCUOUS_MODE (0x51)
121 #define MAC_RX_ON_WHEN_IDLE (0x52)
122 #define MAC_SHORT_ADDRESS (0x53)
123 #define MAC_SUPERFRAME_ORDER (0x54)
124 #define MAC_ASSOCIATED_PAN_COORD (0x56)
125 #define MAC_MAX_BE (0x57)
126 #define MAC_MAX_FRAME_RETRIES (0x59)
127 #define MAC_RESPONSE_WAIT_TIME (0x5A)
128 #define MAC_SECURITY_ENABLED (0x5D)
130 #define MAC_AUTO_REQUEST_SECURITY_LEVEL (0x78)
131 #define MAC_AUTO_REQUEST_KEY_ID_MODE (0x79)
133 #define NS_IEEE_ADDRESS (0xFF) /* Non-standard IEEE address */
135 /* MAC Address Mode Definitions */
136 #define MAC_MODE_NO_ADDR (0x00)
137 #define MAC_MODE_SHORT_ADDR (0x02)
138 #define MAC_MODE_LONG_ADDR (0x03)
141 #define MAX_BEACON_OVERHEAD (75)
142 #define MAX_BEACON_PAYLOAD_LENGTH (IEEE802154_MTU - MAX_BEACON_OVERHEAD)
144 #define MAX_ATTRIBUTE_SIZE (122)
145 #define MAX_DATA_SIZE (114)
147 #define CA8210_VALID_CHANNELS (0x07FFF800)
149 /* MAC workarounds for V1.1 and MPW silicon (V0.x) */
150 #define CA8210_MAC_WORKAROUNDS (0)
151 #define CA8210_MAC_MPW (0)
153 /* memory manipulation macros */
154 #define LS_BYTE(x) ((u8)((x) & 0xFF))
155 #define MS_BYTE(x) ((u8)(((x) >> 8) & 0xFF))
157 /* message ID codes in SPI commands */
159 #define MCPS_DATA_REQUEST (0x00)
160 #define MLME_ASSOCIATE_REQUEST (0x02)
161 #define MLME_ASSOCIATE_RESPONSE (0x03)
162 #define MLME_DISASSOCIATE_REQUEST (0x04)
163 #define MLME_GET_REQUEST (0x05)
164 #define MLME_ORPHAN_RESPONSE (0x06)
165 #define MLME_RESET_REQUEST (0x07)
166 #define MLME_RX_ENABLE_REQUEST (0x08)
167 #define MLME_SCAN_REQUEST (0x09)
168 #define MLME_SET_REQUEST (0x0A)
169 #define MLME_START_REQUEST (0x0B)
170 #define MLME_POLL_REQUEST (0x0D)
171 #define HWME_SET_REQUEST (0x0E)
172 #define HWME_GET_REQUEST (0x0F)
173 #define TDME_SETSFR_REQUEST (0x11)
174 #define TDME_GETSFR_REQUEST (0x12)
175 #define TDME_SET_REQUEST (0x14)
177 #define MCPS_DATA_INDICATION (0x00)
178 #define MCPS_DATA_CONFIRM (0x01)
179 #define MLME_RESET_CONFIRM (0x0A)
180 #define MLME_SET_CONFIRM (0x0E)
181 #define MLME_START_CONFIRM (0x0F)
182 #define HWME_SET_CONFIRM (0x12)
183 #define HWME_GET_CONFIRM (0x13)
184 #define HWME_WAKEUP_INDICATION (0x15)
185 #define TDME_SETSFR_CONFIRM (0x17)
187 /* SPI command IDs */
188 /* bit indicating a confirm or indication from slave to master */
189 #define SPI_S2M (0x20)
190 /* bit indicating a synchronous message */
191 #define SPI_SYN (0x40)
193 /* SPI command definitions */
194 #define SPI_IDLE (0xFF)
195 #define SPI_NACK (0xF0)
197 #define SPI_MCPS_DATA_REQUEST (MCPS_DATA_REQUEST)
198 #define SPI_MCPS_DATA_INDICATION (MCPS_DATA_INDICATION + SPI_S2M)
199 #define SPI_MCPS_DATA_CONFIRM (MCPS_DATA_CONFIRM + SPI_S2M)
201 #define SPI_MLME_ASSOCIATE_REQUEST (MLME_ASSOCIATE_REQUEST)
202 #define SPI_MLME_RESET_REQUEST (MLME_RESET_REQUEST + SPI_SYN)
203 #define SPI_MLME_SET_REQUEST (MLME_SET_REQUEST + SPI_SYN)
204 #define SPI_MLME_START_REQUEST (MLME_START_REQUEST + SPI_SYN)
205 #define SPI_MLME_RESET_CONFIRM (MLME_RESET_CONFIRM + SPI_S2M + SPI_SYN)
206 #define SPI_MLME_SET_CONFIRM (MLME_SET_CONFIRM + SPI_S2M + SPI_SYN)
207 #define SPI_MLME_START_CONFIRM (MLME_START_CONFIRM + SPI_S2M + SPI_SYN)
209 #define SPI_HWME_SET_REQUEST (HWME_SET_REQUEST + SPI_SYN)
210 #define SPI_HWME_GET_REQUEST (HWME_GET_REQUEST + SPI_SYN)
211 #define SPI_HWME_SET_CONFIRM (HWME_SET_CONFIRM + SPI_S2M + SPI_SYN)
212 #define SPI_HWME_GET_CONFIRM (HWME_GET_CONFIRM + SPI_S2M + SPI_SYN)
213 #define SPI_HWME_WAKEUP_INDICATION (HWME_WAKEUP_INDICATION + SPI_S2M)
215 #define SPI_TDME_SETSFR_REQUEST (TDME_SETSFR_REQUEST + SPI_SYN)
216 #define SPI_TDME_SET_REQUEST (TDME_SET_REQUEST + SPI_SYN)
217 #define SPI_TDME_SETSFR_CONFIRM (TDME_SETSFR_CONFIRM + SPI_S2M + SPI_SYN)
219 /* TDME SFR addresses */
221 #define CA8210_SFR_PACFG (0xB1)
222 #define CA8210_SFR_MACCON (0xD8)
223 #define CA8210_SFR_PACFGIB (0xFE)
225 #define CA8210_SFR_LOTXCAL (0xBF)
226 #define CA8210_SFR_PTHRH (0xD1)
227 #define CA8210_SFR_PRECFG (0xD3)
228 #define CA8210_SFR_LNAGX40 (0xE1)
229 #define CA8210_SFR_LNAGX41 (0xE2)
230 #define CA8210_SFR_LNAGX42 (0xE3)
231 #define CA8210_SFR_LNAGX43 (0xE4)
232 #define CA8210_SFR_LNAGX44 (0xE5)
233 #define CA8210_SFR_LNAGX45 (0xE6)
234 #define CA8210_SFR_LNAGX46 (0xE7)
235 #define CA8210_SFR_LNAGX47 (0xE9)
237 #define PACFGIB_DEFAULT_CURRENT (0x3F)
238 #define PTHRH_DEFAULT_THRESHOLD (0x5A)
239 #define LNAGX40_DEFAULT_GAIN (0x29) /* 10dB */
240 #define LNAGX41_DEFAULT_GAIN (0x54) /* 21dB */
241 #define LNAGX42_DEFAULT_GAIN (0x6C) /* 27dB */
242 #define LNAGX43_DEFAULT_GAIN (0x7A) /* 30dB */
243 #define LNAGX44_DEFAULT_GAIN (0x84) /* 33dB */
244 #define LNAGX45_DEFAULT_GAIN (0x8B) /* 34dB */
245 #define LNAGX46_DEFAULT_GAIN (0x92) /* 36dB */
246 #define LNAGX47_DEFAULT_GAIN (0x96) /* 37dB */
248 #define CA8210_IOCTL_HARD_RESET (0x00)
253 * struct cas_control - spi transfer structure
254 * @msg: spi_message for each exchange
255 * @transfer: spi_transfer for each exchange
256 * @tx_buf: source array for transmission
257 * @tx_in_buf: array storing bytes received during transmission
258 * @priv: pointer to private data
260 * This structure stores all the necessary data passed around during a single
264 struct spi_message msg;
265 struct spi_transfer transfer;
267 u8 tx_buf[CA8210_SPI_BUF_SIZE];
268 u8 tx_in_buf[CA8210_SPI_BUF_SIZE];
270 struct ca8210_priv *priv;
274 * struct ca8210_test - ca8210 test interface structure
275 * @ca8210_dfs_spi_int: pointer to the entry in the debug fs for this device
276 * @up_fifo: fifo for upstream messages
277 * @readq: read wait queue
279 * This structure stores all the data pertaining to the debug interface
282 struct dentry *ca8210_dfs_spi_int;
283 struct kfifo up_fifo;
284 wait_queue_head_t readq;
288 * struct ca8210_priv - ca8210 private data structure
289 * @spi: pointer to the ca8210 spi device object
290 * @hw: pointer to the ca8210 ieee802154_hw object
291 * @hw_registered: true if hw has been registered with ieee802154
292 * @lock: spinlock protecting the private data area
293 * @mlme_workqueue: workqueue for triggering MLME Reset
294 * @irq_workqueue: workqueue for irq processing
295 * @tx_skb: current socket buffer to transmit
296 * @nextmsduhandle: msdu handle to pass to the 15.4 MAC layer for the
298 * @clk: external clock provided by the ca8210
299 * @last_dsn: sequence number of last data packet received, for
301 * @test: test interface data section for this instance
302 * @async_tx_pending: true if an asynchronous transmission was started and
304 * @sync_command_response: pointer to buffer to fill with sync response
305 * @ca8210_is_awake: nonzero if ca8210 is initialised, ready for comms
306 * @sync_down: counts number of downstream synchronous commands
307 * @sync_up: counts number of upstream synchronous commands
308 * @spi_transfer_complete: completion object for a single spi_transfer
309 * @sync_exchange_complete: completion object for a complete synchronous API
311 * @promiscuous: whether the ca8210 is in promiscuous mode or not
312 * @retries: records how many times the current pending spi
313 * transfer has been retried
316 struct spi_device *spi;
317 struct ieee802154_hw *hw;
320 struct workqueue_struct *mlme_workqueue;
321 struct workqueue_struct *irq_workqueue;
322 struct sk_buff *tx_skb;
326 struct ca8210_test test;
327 bool async_tx_pending;
328 u8 *sync_command_response;
329 struct completion ca8210_is_awake;
330 int sync_down, sync_up;
331 struct completion spi_transfer_complete, sync_exchange_complete;
337 * struct work_priv_container - link between a work object and the relevant
338 * device's private data
339 * @work: work object being executed
340 * @priv: device's private data section
343 struct work_priv_container {
344 struct work_struct work;
345 struct ca8210_priv *priv;
349 * struct ca8210_platform_data - ca8210 platform data structure
350 * @extclockenable: true if the external clock is to be enabled
351 * @extclockfreq: frequency of the external clock
352 * @extclockgpio: ca8210 output gpio of the external clock
353 * @gpio_reset: gpio number of ca8210 reset line
354 * @gpio_irq: gpio number of ca8210 interrupt line
355 * @irq_id: identifier for the ca8210 irq
358 struct ca8210_platform_data {
360 unsigned int extclockfreq;
361 unsigned int extclockgpio;
368 * struct fulladdr - full MAC addressing information structure
369 * @mode: address mode (none, short, extended)
370 * @pan_id: 16-bit LE pan id
371 * @address: LE address, variable length as specified by mode
381 * union macaddr: generic MAC address container
382 * @short_address: 16-bit short address
383 * @ieee_address: 64-bit extended address as LE byte array
392 * struct secspec: security specification for SAP commands
393 * @security_level: 0-7, controls level of authentication & encryption
394 * @key_id_mode: 0-3, specifies how to obtain key
395 * @key_source: extended key retrieval data
396 * @key_index: single-byte key identifier
406 /* downlink functions parameter set definitions */
407 struct mcps_data_request_pset {
413 u8 msdu[MAX_DATA_SIZE];
416 struct mlme_set_request_pset {
418 u8 pib_attribute_index;
419 u8 pib_attribute_length;
420 u8 pib_attribute_value[MAX_ATTRIBUTE_SIZE];
423 struct hwme_set_request_pset {
425 u8 hw_attribute_length;
426 u8 hw_attribute_value[MAX_HWME_ATTRIBUTE_SIZE];
429 struct hwme_get_request_pset {
433 struct tdme_setsfr_request_pset {
439 /* uplink functions parameter set definitions */
440 struct hwme_set_confirm_pset {
445 struct hwme_get_confirm_pset {
448 u8 hw_attribute_length;
449 u8 hw_attribute_value[MAX_HWME_ATTRIBUTE_SIZE];
452 struct tdme_setsfr_confirm_pset {
462 struct mcps_data_request_pset data_req;
463 struct mlme_set_request_pset set_req;
464 struct hwme_set_request_pset hwme_set_req;
465 struct hwme_get_request_pset hwme_get_req;
466 struct tdme_setsfr_request_pset tdme_set_sfr_req;
467 struct hwme_set_confirm_pset hwme_set_cnf;
468 struct hwme_get_confirm_pset hwme_get_cnf;
469 struct tdme_setsfr_confirm_pset tdme_set_sfr_cnf;
478 u8 bias_current_trim : 3;
479 u8 /* reserved */ : 1;
480 u8 buffer_capacitor_trim : 3;
486 struct preamble_cfg_sfr {
487 u8 timeout_symbols : 3;
488 u8 acquisition_symbols : 3;
489 u8 search_symbols : 2;
492 static int (*cascoda_api_upstream)(
499 * link_to_linux_err() - Translates an 802.15.4 return code into the closest
501 * @link_status: 802.15.4 status code
503 * Return: 0 or Linux error code
505 static int link_to_linux_err(int link_status)
507 if (link_status < 0) {
508 /* status is already a Linux code */
511 switch (link_status) {
512 case IEEE802154_SUCCESS:
513 case IEEE802154_REALIGNMENT:
515 case IEEE802154_IMPROPER_KEY_TYPE:
516 return -EKEYREJECTED;
517 case IEEE802154_IMPROPER_SECURITY_LEVEL:
518 case IEEE802154_UNSUPPORTED_LEGACY:
519 case IEEE802154_DENIED:
521 case IEEE802154_BEACON_LOST:
522 case IEEE802154_NO_ACK:
523 case IEEE802154_NO_BEACON:
525 case IEEE802154_CHANNEL_ACCESS_FAILURE:
526 case IEEE802154_TX_ACTIVE:
527 case IEEE802154_SCAN_IN_PROGRESS:
529 case IEEE802154_DISABLE_TRX_FAILURE:
530 case IEEE802154_OUT_OF_CAP:
532 case IEEE802154_FRAME_TOO_LONG:
534 case IEEE802154_INVALID_GTS:
535 case IEEE802154_PAST_TIME:
537 case IEEE802154_INVALID_HANDLE:
539 case IEEE802154_INVALID_PARAMETER:
540 case IEEE802154_UNSUPPORTED_ATTRIBUTE:
541 case IEEE802154_ON_TIME_TOO_LONG:
542 case IEEE802154_INVALID_INDEX:
544 case IEEE802154_NO_DATA:
546 case IEEE802154_NO_SHORT_ADDRESS:
548 case IEEE802154_PAN_ID_CONFLICT:
550 case IEEE802154_TRANSACTION_EXPIRED:
552 case IEEE802154_TRANSACTION_OVERFLOW:
554 case IEEE802154_UNAVAILABLE_KEY:
556 case IEEE802154_INVALID_ADDRESS:
558 case IEEE802154_TRACKING_OFF:
559 case IEEE802154_SUPERFRAME_OVERLAP:
561 case IEEE802154_LIMIT_REACHED:
563 case IEEE802154_READ_ONLY:
571 * ca8210_test_int_driver_write() - Writes a message to the test interface to be
572 * read by the userspace
573 * @buf: Buffer containing upstream message
574 * @len: length of message to write
575 * @spi: SPI device of message originator
577 * Return: 0 or linux error code
579 static int ca8210_test_int_driver_write(
585 struct ca8210_priv *priv = spi_get_drvdata(spi);
586 struct ca8210_test *test = &priv->test;
592 "test_interface: Buffering upstream message:\n"
594 for (i = 0; i < len; i++)
595 dev_dbg(&priv->spi->dev, "%#03x\n", buf[i]);
597 fifo_buffer = kmemdup(buf, len, GFP_KERNEL);
600 kfifo_in(&test->up_fifo, &fifo_buffer, 4);
601 wake_up_interruptible(&priv->test.readq);
608 static int ca8210_net_rx(
609 struct ieee802154_hw *hw,
613 static u8 mlme_reset_request_sync(
617 static int ca8210_spi_transfer(
618 struct spi_device *spi,
624 * ca8210_reset_send() - Hard resets the ca8210 for a given time
625 * @spi: Pointer to target ca8210 spi device
626 * @ms: Milliseconds to hold the reset line low for
628 static void ca8210_reset_send(struct spi_device *spi, unsigned int ms)
630 struct ca8210_platform_data *pdata = spi->dev.platform_data;
631 struct ca8210_priv *priv = spi_get_drvdata(spi);
634 gpio_set_value(pdata->gpio_reset, 0);
635 reinit_completion(&priv->ca8210_is_awake);
637 gpio_set_value(pdata->gpio_reset, 1);
638 priv->promiscuous = false;
640 /* Wait until wakeup indication seen */
641 status = wait_for_completion_interruptible_timeout(
642 &priv->ca8210_is_awake,
643 msecs_to_jiffies(CA8210_SYNC_TIMEOUT)
648 "Fatal: No wakeup from ca8210 after reset!\n"
652 dev_dbg(&spi->dev, "Reset the device\n");
656 * ca8210_mlme_reset_worker() - Resets the MLME, Called when the MAC OVERFLOW
658 * @work: Pointer to work being executed
660 static void ca8210_mlme_reset_worker(struct work_struct *work)
662 struct work_priv_container *wpc = container_of(
664 struct work_priv_container,
667 struct ca8210_priv *priv = wpc->priv;
669 mlme_reset_request_sync(0, priv->spi);
674 * ca8210_rx_done() - Calls various message dispatches responding to a received
676 * @cas_ctl: Pointer to the cas_control object for the relevant spi transfer
678 * Presents a received SAP command from the ca8210 to the Cascoda EVBME, test
679 * interface and network driver.
681 static void ca8210_rx_done(struct cas_control *cas_ctl)
685 struct work_priv_container *mlme_reset_wpc;
686 struct ca8210_priv *priv = cas_ctl->priv;
688 buf = cas_ctl->tx_in_buf;
690 if (len > CA8210_SPI_BUF_SIZE) {
693 "Received packet len (%u) erroneously long\n",
699 if (buf[0] & SPI_SYN) {
700 if (priv->sync_command_response) {
701 memcpy(priv->sync_command_response, buf, len);
702 complete(&priv->sync_exchange_complete);
704 if (cascoda_api_upstream)
705 cascoda_api_upstream(buf, len, priv->spi);
709 if (cascoda_api_upstream)
710 cascoda_api_upstream(buf, len, priv->spi);
713 ca8210_net_rx(priv->hw, buf, len);
714 if (buf[0] == SPI_MCPS_DATA_CONFIRM) {
715 if (buf[3] == IEEE802154_TRANSACTION_OVERFLOW) {
718 "Waiting for transaction overflow to stabilise...\n");
722 "Resetting MAC...\n");
724 mlme_reset_wpc = kmalloc(sizeof(*mlme_reset_wpc),
729 &mlme_reset_wpc->work,
730 ca8210_mlme_reset_worker
732 mlme_reset_wpc->priv = priv;
733 queue_work(priv->mlme_workqueue, &mlme_reset_wpc->work);
735 } else if (buf[0] == SPI_HWME_WAKEUP_INDICATION) {
738 "Wakeup indication received, reason:\n"
744 "Transceiver woken up from Power Up / System Reset\n"
750 "Watchdog Timer Time-Out\n"
756 "Transceiver woken up from Power-Off by Sleep Timer Time-Out\n");
761 "Transceiver woken up from Power-Off by GPIO Activity\n"
767 "Transceiver woken up from Standby by Sleep Timer Time-Out\n"
773 "Transceiver woken up from Standby by GPIO Activity\n"
779 "Sleep-Timer Time-Out in Active Mode\n"
783 dev_warn(&priv->spi->dev, "Wakeup reason unknown\n");
786 complete(&priv->ca8210_is_awake);
792 static void ca8210_remove(struct spi_device *spi_device);
795 * ca8210_spi_transfer_complete() - Called when a single spi transfer has
797 * @context: Pointer to the cas_control object for the finished transfer
799 static void ca8210_spi_transfer_complete(void *context)
801 struct cas_control *cas_ctl = context;
802 struct ca8210_priv *priv = cas_ctl->priv;
803 bool duplex_rx = false;
805 u8 retry_buffer[CA8210_SPI_BUF_SIZE];
808 cas_ctl->tx_in_buf[0] == SPI_NACK ||
809 (cas_ctl->tx_in_buf[0] == SPI_IDLE &&
810 cas_ctl->tx_in_buf[1] == SPI_NACK)
813 dev_info(&priv->spi->dev, "ca8210 was busy during attempted write\n");
814 if (cas_ctl->tx_buf[0] == SPI_IDLE) {
817 "IRQ servicing NACKd, dropping transfer\n"
822 if (priv->retries > 3) {
823 dev_err(&priv->spi->dev, "too many retries!\n");
825 ca8210_remove(priv->spi);
828 memcpy(retry_buffer, cas_ctl->tx_buf, CA8210_SPI_BUF_SIZE);
836 dev_info(&priv->spi->dev, "retried spi write\n");
839 cas_ctl->tx_in_buf[0] != SPI_IDLE &&
840 cas_ctl->tx_in_buf[0] != SPI_NACK
846 dev_dbg(&priv->spi->dev, "READ CMD DURING TX\n");
847 for (i = 0; i < cas_ctl->tx_in_buf[1] + 2; i++)
851 cas_ctl->tx_in_buf[i]
853 ca8210_rx_done(cas_ctl);
855 complete(&priv->spi_transfer_complete);
861 * ca8210_spi_transfer() - Initiate duplex spi transfer with ca8210
862 * @spi: Pointer to spi device for transfer
863 * @buf: Octet array to send
864 * @len: length of the buffer being sent
866 * Return: 0 or linux error code
868 static int ca8210_spi_transfer(
869 struct spi_device *spi,
875 struct ca8210_priv *priv;
876 struct cas_control *cas_ctl;
879 pr_crit("NULL spi device passed to %s\n", __func__);
883 priv = spi_get_drvdata(spi);
884 reinit_completion(&priv->spi_transfer_complete);
886 dev_dbg(&spi->dev, "%s called\n", __func__);
888 cas_ctl = kzalloc(sizeof(*cas_ctl), GFP_ATOMIC);
892 cas_ctl->priv = priv;
893 memset(cas_ctl->tx_buf, SPI_IDLE, CA8210_SPI_BUF_SIZE);
894 memset(cas_ctl->tx_in_buf, SPI_IDLE, CA8210_SPI_BUF_SIZE);
895 memcpy(cas_ctl->tx_buf, buf, len);
897 for (i = 0; i < len; i++)
898 dev_dbg(&spi->dev, "%#03x\n", cas_ctl->tx_buf[i]);
900 spi_message_init(&cas_ctl->msg);
902 cas_ctl->transfer.tx_nbits = 1; /* 1 MOSI line */
903 cas_ctl->transfer.rx_nbits = 1; /* 1 MISO line */
904 cas_ctl->transfer.speed_hz = 0; /* Use device setting */
905 cas_ctl->transfer.bits_per_word = 0; /* Use device setting */
906 cas_ctl->transfer.tx_buf = cas_ctl->tx_buf;
907 cas_ctl->transfer.rx_buf = cas_ctl->tx_in_buf;
908 cas_ctl->transfer.delay.value = 0;
909 cas_ctl->transfer.delay.unit = SPI_DELAY_UNIT_USECS;
910 cas_ctl->transfer.cs_change = 0;
911 cas_ctl->transfer.len = sizeof(struct mac_message);
912 cas_ctl->msg.complete = ca8210_spi_transfer_complete;
913 cas_ctl->msg.context = cas_ctl;
915 spi_message_add_tail(
920 status = spi_async(spi, &cas_ctl->msg);
924 "status %d from spi_sync in write\n",
933 * ca8210_spi_exchange() - Exchange API/SAP commands with the radio
934 * @buf: Octet array of command being sent downstream
935 * @len: length of buf
936 * @response: buffer for storing synchronous response
937 * @device_ref: spi_device pointer for ca8210
939 * Effectively calls ca8210_spi_transfer to write buf[] to the spi, then for
940 * synchronous commands waits for the corresponding response to be read from
941 * the spi before returning. The response is written to the response parameter.
943 * Return: 0 or linux error code
945 static int ca8210_spi_exchange(
953 struct spi_device *spi = device_ref;
954 struct ca8210_priv *priv = spi->dev.driver_data;
957 if ((buf[0] & SPI_SYN) && response) { /* if sync wait for confirm */
958 reinit_completion(&priv->sync_exchange_complete);
959 priv->sync_command_response = response;
963 reinit_completion(&priv->spi_transfer_complete);
964 status = ca8210_spi_transfer(priv->spi, buf, len);
968 "spi write failed, returned %d\n",
971 if (status == -EBUSY)
973 if (((buf[0] & SPI_SYN) && response))
974 complete(&priv->sync_exchange_complete);
978 wait_remaining = wait_for_completion_interruptible_timeout(
979 &priv->spi_transfer_complete,
980 msecs_to_jiffies(1000)
982 if (wait_remaining == -ERESTARTSYS) {
983 status = -ERESTARTSYS;
984 } else if (wait_remaining == 0) {
987 "SPI downstream transfer timed out!\n"
992 } while (status < 0);
994 if (!((buf[0] & SPI_SYN) && response))
997 wait_remaining = wait_for_completion_interruptible_timeout(
998 &priv->sync_exchange_complete,
999 msecs_to_jiffies(CA8210_SYNC_TIMEOUT)
1001 if (wait_remaining == -ERESTARTSYS) {
1002 status = -ERESTARTSYS;
1003 } else if (wait_remaining == 0) {
1006 "Synchronous confirm timeout\n"
1012 priv->sync_command_response = NULL;
1017 * ca8210_interrupt_handler() - Called when an irq is received from the ca8210
1018 * @irq: Id of the irq being handled
1019 * @dev_id: Pointer passed by the system, pointing to the ca8210's private data
1021 * This function is called when the irq line from the ca8210 is asserted,
1022 * signifying that the ca8210 has a message to send upstream to us. Starts the
1023 * asynchronous spi read.
1025 * Return: irq return code
1027 static irqreturn_t ca8210_interrupt_handler(int irq, void *dev_id)
1029 struct ca8210_priv *priv = dev_id;
1032 dev_dbg(&priv->spi->dev, "irq: Interrupt occurred\n");
1034 status = ca8210_spi_transfer(priv->spi, NULL, 0);
1035 if (status && (status != -EBUSY)) {
1038 "spi read failed, returned %d\n",
1042 } while (status == -EBUSY);
1046 static int (*cascoda_api_downstream)(
1051 ) = ca8210_spi_exchange;
1053 /* Cascoda API / 15.4 SAP Primitives */
1056 * tdme_setsfr_request_sync() - TDME_SETSFR_request/confirm according to API
1057 * @sfr_page: SFR Page
1058 * @sfr_address: SFR Address
1059 * @sfr_value: SFR Value
1060 * @device_ref: Nondescript pointer to target device
1062 * Return: 802.15.4 status code of TDME-SETSFR.confirm
1064 static u8 tdme_setsfr_request_sync(
1072 struct mac_message command, response;
1073 struct spi_device *spi = device_ref;
1075 command.command_id = SPI_TDME_SETSFR_REQUEST;
1077 command.pdata.tdme_set_sfr_req.sfr_page = sfr_page;
1078 command.pdata.tdme_set_sfr_req.sfr_address = sfr_address;
1079 command.pdata.tdme_set_sfr_req.sfr_value = sfr_value;
1080 response.command_id = SPI_IDLE;
1081 ret = cascoda_api_downstream(
1082 &command.command_id,
1084 &response.command_id,
1088 dev_crit(&spi->dev, "cascoda_api_downstream returned %d", ret);
1089 return IEEE802154_SYSTEM_ERROR;
1092 if (response.command_id != SPI_TDME_SETSFR_CONFIRM) {
1095 "sync response to SPI_TDME_SETSFR_REQUEST was not SPI_TDME_SETSFR_CONFIRM, it was %d\n",
1098 return IEEE802154_SYSTEM_ERROR;
1101 return response.pdata.tdme_set_sfr_cnf.status;
1105 * tdme_chipinit() - TDME Chip Register Default Initialisation Macro
1106 * @device_ref: Nondescript pointer to target device
1108 * Return: 802.15.4 status code of API calls
1110 static u8 tdme_chipinit(void *device_ref)
1112 u8 status = IEEE802154_SUCCESS;
1114 struct spi_device *spi = device_ref;
1115 struct preamble_cfg_sfr pre_cfg_value = {
1116 .timeout_symbols = 3,
1117 .acquisition_symbols = 3,
1118 .search_symbols = 1,
1120 /* LNA Gain Settings */
1121 status = tdme_setsfr_request_sync(
1122 1, (sfr_address = CA8210_SFR_LNAGX40),
1123 LNAGX40_DEFAULT_GAIN, device_ref);
1126 status = tdme_setsfr_request_sync(
1127 1, (sfr_address = CA8210_SFR_LNAGX41),
1128 LNAGX41_DEFAULT_GAIN, device_ref);
1131 status = tdme_setsfr_request_sync(
1132 1, (sfr_address = CA8210_SFR_LNAGX42),
1133 LNAGX42_DEFAULT_GAIN, device_ref);
1136 status = tdme_setsfr_request_sync(
1137 1, (sfr_address = CA8210_SFR_LNAGX43),
1138 LNAGX43_DEFAULT_GAIN, device_ref);
1141 status = tdme_setsfr_request_sync(
1142 1, (sfr_address = CA8210_SFR_LNAGX44),
1143 LNAGX44_DEFAULT_GAIN, device_ref);
1146 status = tdme_setsfr_request_sync(
1147 1, (sfr_address = CA8210_SFR_LNAGX45),
1148 LNAGX45_DEFAULT_GAIN, device_ref);
1151 status = tdme_setsfr_request_sync(
1152 1, (sfr_address = CA8210_SFR_LNAGX46),
1153 LNAGX46_DEFAULT_GAIN, device_ref);
1156 status = tdme_setsfr_request_sync(
1157 1, (sfr_address = CA8210_SFR_LNAGX47),
1158 LNAGX47_DEFAULT_GAIN, device_ref);
1161 /* Preamble Timing Config */
1162 status = tdme_setsfr_request_sync(
1163 1, (sfr_address = CA8210_SFR_PRECFG),
1164 *((u8 *)&pre_cfg_value), device_ref);
1167 /* Preamble Threshold High */
1168 status = tdme_setsfr_request_sync(
1169 1, (sfr_address = CA8210_SFR_PTHRH),
1170 PTHRH_DEFAULT_THRESHOLD, device_ref);
1173 /* Tx Output Power 8 dBm */
1174 status = tdme_setsfr_request_sync(
1175 0, (sfr_address = CA8210_SFR_PACFGIB),
1176 PACFGIB_DEFAULT_CURRENT, device_ref);
1181 if (status != IEEE802154_SUCCESS) {
1184 "failed to set sfr at %#03x, status = %#03x\n",
1193 * tdme_channelinit() - TDME Channel Register Default Initialisation Macro (Tx)
1194 * @channel: 802.15.4 channel to initialise chip for
1195 * @device_ref: Nondescript pointer to target device
1197 * Return: 802.15.4 status code of API calls
1199 static u8 tdme_channelinit(u8 channel, void *device_ref)
1201 /* Transceiver front-end local oscillator tx two-point calibration
1202 * value. Tuned for the hardware.
1208 else if (channel >= 23)
1210 else if (channel >= 22)
1212 else if (channel >= 20)
1214 else if (channel >= 17)
1216 else if (channel >= 16)
1218 else if (channel >= 14)
1220 else if (channel >= 12)
1225 return tdme_setsfr_request_sync(
1234 * tdme_checkpibattribute() - Checks Attribute Values that are not checked in
1236 * @pib_attribute: Attribute Number
1237 * @pib_attribute_length: Attribute length
1238 * @pib_attribute_value: Pointer to Attribute Value
1240 * Return: 802.15.4 status code of checks
1242 static u8 tdme_checkpibattribute(
1244 u8 pib_attribute_length,
1245 const void *pib_attribute_value
1248 u8 status = IEEE802154_SUCCESS;
1251 value = *((u8 *)pib_attribute_value);
1253 switch (pib_attribute) {
1255 case PHY_TRANSMIT_POWER:
1257 status = IEEE802154_INVALID_PARAMETER;
1261 status = IEEE802154_INVALID_PARAMETER;
1264 case MAC_BATT_LIFE_EXT_PERIODS:
1265 if (value < 6 || value > 41)
1266 status = IEEE802154_INVALID_PARAMETER;
1268 case MAC_BEACON_PAYLOAD:
1269 if (pib_attribute_length > MAX_BEACON_PAYLOAD_LENGTH)
1270 status = IEEE802154_INVALID_PARAMETER;
1272 case MAC_BEACON_PAYLOAD_LENGTH:
1273 if (value > MAX_BEACON_PAYLOAD_LENGTH)
1274 status = IEEE802154_INVALID_PARAMETER;
1276 case MAC_BEACON_ORDER:
1278 status = IEEE802154_INVALID_PARAMETER;
1281 if (value < 3 || value > 8)
1282 status = IEEE802154_INVALID_PARAMETER;
1284 case MAC_MAX_CSMA_BACKOFFS:
1286 status = IEEE802154_INVALID_PARAMETER;
1288 case MAC_MAX_FRAME_RETRIES:
1290 status = IEEE802154_INVALID_PARAMETER;
1294 status = IEEE802154_INVALID_PARAMETER;
1296 case MAC_RESPONSE_WAIT_TIME:
1297 if (value < 2 || value > 64)
1298 status = IEEE802154_INVALID_PARAMETER;
1300 case MAC_SUPERFRAME_ORDER:
1302 status = IEEE802154_INVALID_PARAMETER;
1305 case MAC_ASSOCIATED_PAN_COORD:
1306 case MAC_ASSOCIATION_PERMIT:
1307 case MAC_AUTO_REQUEST:
1308 case MAC_BATT_LIFE_EXT:
1309 case MAC_GTS_PERMIT:
1310 case MAC_PROMISCUOUS_MODE:
1311 case MAC_RX_ON_WHEN_IDLE:
1312 case MAC_SECURITY_ENABLED:
1314 status = IEEE802154_INVALID_PARAMETER;
1317 case MAC_AUTO_REQUEST_SECURITY_LEVEL:
1319 status = IEEE802154_INVALID_PARAMETER;
1321 case MAC_AUTO_REQUEST_KEY_ID_MODE:
1323 status = IEEE802154_INVALID_PARAMETER;
1333 * tdme_settxpower() - Sets the tx power for MLME_SET phyTransmitPower
1334 * @txp: Transmit Power
1335 * @device_ref: Nondescript pointer to target device
1337 * Normalised to 802.15.4 Definition (6-bit, signed):
1339 * Bit 5-0: tx power (-32 - +31 dB)
1341 * Return: 802.15.4 status code of api calls
1343 static u8 tdme_settxpower(u8 txp, void *device_ref)
1348 union pa_cfg_sfr pa_cfg_val;
1350 /* extend from 6 to 8 bit */
1351 txp_ext = 0x3F & txp;
1354 txp_val = (s8)txp_ext;
1356 if (CA8210_MAC_MPW) {
1358 /* 8 dBm: ptrim = 5, itrim = +3 => +4 dBm */
1359 pa_cfg_val.bias_current_trim = 3;
1360 pa_cfg_val.buffer_capacitor_trim = 5;
1361 pa_cfg_val.boost = 1;
1363 /* 0 dBm: ptrim = 7, itrim = +3 => -6 dBm */
1364 pa_cfg_val.bias_current_trim = 3;
1365 pa_cfg_val.buffer_capacitor_trim = 7;
1366 pa_cfg_val.boost = 0;
1369 status = tdme_setsfr_request_sync(
1376 /* Look-Up Table for Setting Current and Frequency Trim values
1377 * for desired Output Power
1380 pa_cfg_val.paib = 0x3F;
1381 } else if (txp_val == 8) {
1382 pa_cfg_val.paib = 0x32;
1383 } else if (txp_val == 7) {
1384 pa_cfg_val.paib = 0x22;
1385 } else if (txp_val == 6) {
1386 pa_cfg_val.paib = 0x18;
1387 } else if (txp_val == 5) {
1388 pa_cfg_val.paib = 0x10;
1389 } else if (txp_val == 4) {
1390 pa_cfg_val.paib = 0x0C;
1391 } else if (txp_val == 3) {
1392 pa_cfg_val.paib = 0x08;
1393 } else if (txp_val == 2) {
1394 pa_cfg_val.paib = 0x05;
1395 } else if (txp_val == 1) {
1396 pa_cfg_val.paib = 0x03;
1397 } else if (txp_val == 0) {
1398 pa_cfg_val.paib = 0x01;
1400 pa_cfg_val.paib = 0x00;
1403 status = tdme_setsfr_request_sync(
1415 * mcps_data_request() - mcps_data_request (Send Data) according to API Spec
1416 * @src_addr_mode: Source Addressing Mode
1417 * @dst_address_mode: Destination Addressing Mode
1418 * @dst_pan_id: Destination PAN ID
1419 * @dst_addr: Pointer to Destination Address
1420 * @msdu_length: length of Data
1421 * @msdu: Pointer to Data
1422 * @msdu_handle: Handle of Data
1423 * @tx_options: Tx Options Bit Field
1424 * @security: Pointer to Security Structure or NULL
1425 * @device_ref: Nondescript pointer to target device
1427 * Return: 802.15.4 status code of action
1429 static u8 mcps_data_request(
1431 u8 dst_address_mode,
1433 union macaddr *dst_addr,
1438 struct secspec *security,
1442 struct secspec *psec;
1443 struct mac_message command;
1445 command.command_id = SPI_MCPS_DATA_REQUEST;
1446 command.pdata.data_req.src_addr_mode = src_addr_mode;
1447 command.pdata.data_req.dst.mode = dst_address_mode;
1448 if (dst_address_mode != MAC_MODE_NO_ADDR) {
1449 command.pdata.data_req.dst.pan_id[0] = LS_BYTE(dst_pan_id);
1450 command.pdata.data_req.dst.pan_id[1] = MS_BYTE(dst_pan_id);
1451 if (dst_address_mode == MAC_MODE_SHORT_ADDR) {
1452 command.pdata.data_req.dst.address[0] = LS_BYTE(
1453 dst_addr->short_address
1455 command.pdata.data_req.dst.address[1] = MS_BYTE(
1456 dst_addr->short_address
1458 } else { /* MAC_MODE_LONG_ADDR*/
1460 command.pdata.data_req.dst.address,
1461 dst_addr->ieee_address,
1466 command.pdata.data_req.msdu_length = msdu_length;
1467 command.pdata.data_req.msdu_handle = msdu_handle;
1468 command.pdata.data_req.tx_options = tx_options;
1469 memcpy(command.pdata.data_req.msdu, msdu, msdu_length);
1470 psec = (struct secspec *)(command.pdata.data_req.msdu + msdu_length);
1471 command.length = sizeof(struct mcps_data_request_pset) -
1472 MAX_DATA_SIZE + msdu_length;
1473 if (!security || security->security_level == 0) {
1474 psec->security_level = 0;
1475 command.length += 1;
1478 command.length += sizeof(struct secspec);
1481 if (ca8210_spi_transfer(device_ref, &command.command_id,
1482 command.length + 2))
1483 return IEEE802154_SYSTEM_ERROR;
1485 return IEEE802154_SUCCESS;
1489 * mlme_reset_request_sync() - MLME_RESET_request/confirm according to API Spec
1490 * @set_default_pib: Set defaults in PIB
1491 * @device_ref: Nondescript pointer to target device
1493 * Return: 802.15.4 status code of MLME-RESET.confirm
1495 static u8 mlme_reset_request_sync(
1501 struct mac_message command, response;
1502 struct spi_device *spi = device_ref;
1504 command.command_id = SPI_MLME_RESET_REQUEST;
1506 command.pdata.u8param = set_default_pib;
1508 if (cascoda_api_downstream(
1509 &command.command_id,
1511 &response.command_id,
1513 dev_err(&spi->dev, "cascoda_api_downstream failed\n");
1514 return IEEE802154_SYSTEM_ERROR;
1517 if (response.command_id != SPI_MLME_RESET_CONFIRM)
1518 return IEEE802154_SYSTEM_ERROR;
1520 status = response.pdata.status;
1522 /* reset COORD Bit for Channel Filtering as Coordinator */
1523 if (CA8210_MAC_WORKAROUNDS && set_default_pib && !status) {
1524 status = tdme_setsfr_request_sync(
1536 * mlme_set_request_sync() - MLME_SET_request/confirm according to API Spec
1537 * @pib_attribute: Attribute Number
1538 * @pib_attribute_index: Index within Attribute if an Array
1539 * @pib_attribute_length: Attribute length
1540 * @pib_attribute_value: Pointer to Attribute Value
1541 * @device_ref: Nondescript pointer to target device
1543 * Return: 802.15.4 status code of MLME-SET.confirm
1545 static u8 mlme_set_request_sync(
1547 u8 pib_attribute_index,
1548 u8 pib_attribute_length,
1549 const void *pib_attribute_value,
1554 struct mac_message command, response;
1556 /* pre-check the validity of pib_attribute values that are not checked
1559 if (tdme_checkpibattribute(
1560 pib_attribute, pib_attribute_length, pib_attribute_value)) {
1561 return IEEE802154_INVALID_PARAMETER;
1564 if (pib_attribute == PHY_CURRENT_CHANNEL) {
1565 status = tdme_channelinit(
1566 *((u8 *)pib_attribute_value),
1573 if (pib_attribute == PHY_TRANSMIT_POWER) {
1574 return tdme_settxpower(
1575 *((u8 *)pib_attribute_value),
1580 command.command_id = SPI_MLME_SET_REQUEST;
1581 command.length = sizeof(struct mlme_set_request_pset) -
1582 MAX_ATTRIBUTE_SIZE + pib_attribute_length;
1583 command.pdata.set_req.pib_attribute = pib_attribute;
1584 command.pdata.set_req.pib_attribute_index = pib_attribute_index;
1585 command.pdata.set_req.pib_attribute_length = pib_attribute_length;
1587 command.pdata.set_req.pib_attribute_value,
1588 pib_attribute_value,
1589 pib_attribute_length
1592 if (cascoda_api_downstream(
1593 &command.command_id,
1595 &response.command_id,
1597 return IEEE802154_SYSTEM_ERROR;
1600 if (response.command_id != SPI_MLME_SET_CONFIRM)
1601 return IEEE802154_SYSTEM_ERROR;
1603 return response.pdata.status;
1607 * hwme_set_request_sync() - HWME_SET_request/confirm according to API Spec
1608 * @hw_attribute: Attribute Number
1609 * @hw_attribute_length: Attribute length
1610 * @hw_attribute_value: Pointer to Attribute Value
1611 * @device_ref: Nondescript pointer to target device
1613 * Return: 802.15.4 status code of HWME-SET.confirm
1615 static u8 hwme_set_request_sync(
1617 u8 hw_attribute_length,
1618 u8 *hw_attribute_value,
1622 struct mac_message command, response;
1624 command.command_id = SPI_HWME_SET_REQUEST;
1625 command.length = 2 + hw_attribute_length;
1626 command.pdata.hwme_set_req.hw_attribute = hw_attribute;
1627 command.pdata.hwme_set_req.hw_attribute_length = hw_attribute_length;
1629 command.pdata.hwme_set_req.hw_attribute_value,
1634 if (cascoda_api_downstream(
1635 &command.command_id,
1637 &response.command_id,
1639 return IEEE802154_SYSTEM_ERROR;
1642 if (response.command_id != SPI_HWME_SET_CONFIRM)
1643 return IEEE802154_SYSTEM_ERROR;
1645 return response.pdata.hwme_set_cnf.status;
1649 * hwme_get_request_sync() - HWME_GET_request/confirm according to API Spec
1650 * @hw_attribute: Attribute Number
1651 * @hw_attribute_length: Attribute length
1652 * @hw_attribute_value: Pointer to Attribute Value
1653 * @device_ref: Nondescript pointer to target device
1655 * Return: 802.15.4 status code of HWME-GET.confirm
1657 static u8 hwme_get_request_sync(
1659 u8 *hw_attribute_length,
1660 u8 *hw_attribute_value,
1664 struct mac_message command, response;
1666 command.command_id = SPI_HWME_GET_REQUEST;
1668 command.pdata.hwme_get_req.hw_attribute = hw_attribute;
1670 if (cascoda_api_downstream(
1671 &command.command_id,
1673 &response.command_id,
1675 return IEEE802154_SYSTEM_ERROR;
1678 if (response.command_id != SPI_HWME_GET_CONFIRM)
1679 return IEEE802154_SYSTEM_ERROR;
1681 if (response.pdata.hwme_get_cnf.status == IEEE802154_SUCCESS) {
1682 *hw_attribute_length =
1683 response.pdata.hwme_get_cnf.hw_attribute_length;
1686 response.pdata.hwme_get_cnf.hw_attribute_value,
1687 *hw_attribute_length
1691 return response.pdata.hwme_get_cnf.status;
1694 /* Network driver operation */
1697 * ca8210_async_xmit_complete() - Called to announce that an asynchronous
1698 * transmission has finished
1699 * @hw: ieee802154_hw of ca8210 that has finished exchange
1700 * @msduhandle: Identifier of transmission that has completed
1701 * @status: Returned 802.15.4 status code of the transmission
1703 * Return: 0 or linux error code
1705 static int ca8210_async_xmit_complete(
1706 struct ieee802154_hw *hw,
1710 struct ca8210_priv *priv = hw->priv;
1712 if (priv->nextmsduhandle != msduhandle) {
1715 "Unexpected msdu_handle on data confirm, Expected %d, got %d\n",
1716 priv->nextmsduhandle,
1722 priv->async_tx_pending = false;
1723 priv->nextmsduhandle++;
1728 "Link transmission unsuccessful, status = %d\n",
1731 if (status != IEEE802154_TRANSACTION_OVERFLOW) {
1732 ieee802154_xmit_error(priv->hw, priv->tx_skb, status);
1736 ieee802154_xmit_complete(priv->hw, priv->tx_skb, true);
1742 * ca8210_skb_rx() - Contructs a properly framed socket buffer from a received
1743 * MCPS_DATA_indication
1744 * @hw: ieee802154_hw that MCPS_DATA_indication was received by
1745 * @len: length of MCPS_DATA_indication
1746 * @data_ind: Octet array of MCPS_DATA_indication
1748 * Called by the spi driver whenever a SAP command is received, this function
1749 * will ascertain whether the command is of interest to the network driver and
1750 * take necessary action.
1752 * Return: 0 or linux error code
1754 static int ca8210_skb_rx(
1755 struct ieee802154_hw *hw,
1760 struct ieee802154_hdr hdr;
1763 u8 mpdulinkquality = data_ind[23];
1764 struct sk_buff *skb;
1765 struct ca8210_priv *priv = hw->priv;
1767 /* Allocate mtu size buffer for every rx packet */
1768 skb = dev_alloc_skb(IEEE802154_MTU + sizeof(hdr));
1772 skb_reserve(skb, sizeof(hdr));
1774 msdulen = data_ind[22]; /* msdu_length */
1775 if (msdulen > IEEE802154_MTU) {
1778 "received erroneously large msdu length!\n"
1783 dev_dbg(&priv->spi->dev, "skb buffer length = %d\n", msdulen);
1785 if (priv->promiscuous)
1789 hdr.sec.level = data_ind[29 + msdulen];
1790 dev_dbg(&priv->spi->dev, "security level: %#03x\n", hdr.sec.level);
1791 if (hdr.sec.level > 0) {
1792 hdr.sec.key_id_mode = data_ind[30 + msdulen];
1793 memcpy(&hdr.sec.extended_src, &data_ind[31 + msdulen], 8);
1794 hdr.sec.key_id = data_ind[39 + msdulen];
1796 hdr.source.mode = data_ind[0];
1797 dev_dbg(&priv->spi->dev, "srcAddrMode: %#03x\n", hdr.source.mode);
1798 hdr.source.pan_id = *(u16 *)&data_ind[1];
1799 dev_dbg(&priv->spi->dev, "srcPanId: %#06x\n", hdr.source.pan_id);
1800 memcpy(&hdr.source.extended_addr, &data_ind[3], 8);
1801 hdr.dest.mode = data_ind[11];
1802 dev_dbg(&priv->spi->dev, "dstAddrMode: %#03x\n", hdr.dest.mode);
1803 hdr.dest.pan_id = *(u16 *)&data_ind[12];
1804 dev_dbg(&priv->spi->dev, "dstPanId: %#06x\n", hdr.dest.pan_id);
1805 memcpy(&hdr.dest.extended_addr, &data_ind[14], 8);
1807 /* Fill in FC implicitly */
1808 hdr.fc.type = 1; /* Data frame */
1810 hdr.fc.security_enabled = 1;
1812 hdr.fc.security_enabled = 0;
1813 if (data_ind[1] != data_ind[12] || data_ind[2] != data_ind[13])
1814 hdr.fc.intra_pan = 1;
1816 hdr.fc.intra_pan = 0;
1817 hdr.fc.dest_addr_mode = hdr.dest.mode;
1818 hdr.fc.source_addr_mode = hdr.source.mode;
1820 /* Add hdr to front of buffer */
1821 hlen = ieee802154_hdr_push(skb, &hdr);
1824 dev_crit(&priv->spi->dev, "failed to push mac hdr onto skb!\n");
1829 skb_reset_mac_header(skb);
1830 skb->mac_len = hlen;
1833 /* Add <msdulen> bytes of space to the back of the buffer */
1834 /* Copy msdu to skb */
1835 skb_put_data(skb, &data_ind[29], msdulen);
1837 ieee802154_rx_irqsafe(hw, skb, mpdulinkquality);
1842 * ca8210_net_rx() - Acts upon received SAP commands relevant to the network
1844 * @hw: ieee802154_hw that command was received by
1845 * @command: Octet array of received command
1846 * @len: length of the received command
1848 * Called by the spi driver whenever a SAP command is received, this function
1849 * will ascertain whether the command is of interest to the network driver and
1850 * take necessary action.
1852 * Return: 0 or linux error code
1854 static int ca8210_net_rx(struct ieee802154_hw *hw, u8 *command, size_t len)
1856 struct ca8210_priv *priv = hw->priv;
1857 unsigned long flags;
1860 dev_dbg(&priv->spi->dev, "%s: CmdID = %d\n", __func__, command[0]);
1862 if (command[0] == SPI_MCPS_DATA_INDICATION) {
1864 spin_lock_irqsave(&priv->lock, flags);
1865 if (command[26] == priv->last_dsn) {
1868 "DSN %d resend received, ignoring...\n",
1871 spin_unlock_irqrestore(&priv->lock, flags);
1874 priv->last_dsn = command[26];
1875 spin_unlock_irqrestore(&priv->lock, flags);
1876 return ca8210_skb_rx(hw, len - 2, command + 2);
1877 } else if (command[0] == SPI_MCPS_DATA_CONFIRM) {
1878 status = command[3];
1879 if (priv->async_tx_pending) {
1880 return ca8210_async_xmit_complete(
1892 * ca8210_skb_tx() - Transmits a given socket buffer using the ca8210
1893 * @skb: Socket buffer to transmit
1894 * @msduhandle: Data identifier to pass to the 802.15.4 MAC
1895 * @priv: Pointer to private data section of target ca8210
1897 * Return: 0 or linux error code
1899 static int ca8210_skb_tx(
1900 struct sk_buff *skb,
1902 struct ca8210_priv *priv
1906 struct ieee802154_hdr header = { };
1907 struct secspec secspec;
1908 unsigned int mac_len;
1910 dev_dbg(&priv->spi->dev, "%s called\n", __func__);
1912 /* Get addressing info from skb - ieee802154 layer creates a full
1915 mac_len = ieee802154_hdr_peek_addrs(skb, &header);
1917 secspec.security_level = header.sec.level;
1918 secspec.key_id_mode = header.sec.key_id_mode;
1919 if (secspec.key_id_mode == 2)
1920 memcpy(secspec.key_source, &header.sec.short_src, 4);
1921 else if (secspec.key_id_mode == 3)
1922 memcpy(secspec.key_source, &header.sec.extended_src, 8);
1923 secspec.key_index = header.sec.key_id;
1925 /* Pass to Cascoda API */
1926 status = mcps_data_request(
1930 (union macaddr *)&header.dest.extended_addr,
1932 &skb->data[mac_len],
1934 header.fc.ack_request,
1938 return link_to_linux_err(status);
1942 * ca8210_start() - Starts the network driver
1943 * @hw: ieee802154_hw of ca8210 being started
1945 * Return: 0 or linux error code
1947 static int ca8210_start(struct ieee802154_hw *hw)
1951 u8 lqi_threshold = 0;
1952 struct ca8210_priv *priv = hw->priv;
1954 priv->last_dsn = -1;
1955 /* Turn receiver on when idle for now just to test rx */
1956 rx_on_when_idle = 1;
1957 status = mlme_set_request_sync(
1958 MAC_RX_ON_WHEN_IDLE,
1967 "Setting rx_on_when_idle failed, status = %d\n",
1970 return link_to_linux_err(status);
1972 status = hwme_set_request_sync(
1981 "Setting lqilimit failed, status = %d\n",
1984 return link_to_linux_err(status);
1991 * ca8210_stop() - Stops the network driver
1992 * @hw: ieee802154_hw of ca8210 being stopped
1994 * Return: 0 or linux error code
1996 static void ca8210_stop(struct ieee802154_hw *hw)
2001 * ca8210_xmit_async() - Asynchronously transmits a given socket buffer using
2003 * @hw: ieee802154_hw of ca8210 to transmit from
2004 * @skb: Socket buffer to transmit
2006 * Return: 0 or linux error code
2008 static int ca8210_xmit_async(struct ieee802154_hw *hw, struct sk_buff *skb)
2010 struct ca8210_priv *priv = hw->priv;
2013 dev_dbg(&priv->spi->dev, "calling %s\n", __func__);
2016 priv->async_tx_pending = true;
2017 status = ca8210_skb_tx(skb, priv->nextmsduhandle, priv);
2022 * ca8210_get_ed() - Returns the measured energy on the current channel at this
2024 * @hw: ieee802154_hw of target ca8210
2025 * @level: Measured Energy Detect level
2027 * Return: 0 or linux error code
2029 static int ca8210_get_ed(struct ieee802154_hw *hw, u8 *level)
2032 struct ca8210_priv *priv = hw->priv;
2034 return link_to_linux_err(
2035 hwme_get_request_sync(HWME_EDVALUE, &lenvar, level, priv->spi)
2040 * ca8210_set_channel() - Sets the current operating 802.15.4 channel of the
2042 * @hw: ieee802154_hw of target ca8210
2043 * @page: Channel page to set
2044 * @channel: Channel number to set
2046 * Return: 0 or linux error code
2048 static int ca8210_set_channel(
2049 struct ieee802154_hw *hw,
2055 struct ca8210_priv *priv = hw->priv;
2057 status = mlme_set_request_sync(
2058 PHY_CURRENT_CHANNEL,
2067 "error setting channel, MLME-SET.confirm status = %d\n",
2071 return link_to_linux_err(status);
2075 * ca8210_set_hw_addr_filt() - Sets the address filtering parameters of the
2077 * @hw: ieee802154_hw of target ca8210
2078 * @filt: Filtering parameters
2079 * @changed: Bitmap representing which parameters to change
2081 * Effectively just sets the actual addressing information identifying this node
2082 * as all filtering is performed by the ca8210 as detailed in the IEEE 802.15.4
2083 * 2006 specification.
2085 * Return: 0 or linux error code
2087 static int ca8210_set_hw_addr_filt(
2088 struct ieee802154_hw *hw,
2089 struct ieee802154_hw_addr_filt *filt,
2090 unsigned long changed
2094 struct ca8210_priv *priv = hw->priv;
2096 if (changed & IEEE802154_AFILT_PANID_CHANGED) {
2097 status = mlme_set_request_sync(
2101 &filt->pan_id, priv->spi
2106 "error setting pan id, MLME-SET.confirm status = %d",
2109 return link_to_linux_err(status);
2112 if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
2113 status = mlme_set_request_sync(
2117 &filt->short_addr, priv->spi
2122 "error setting short address, MLME-SET.confirm status = %d",
2125 return link_to_linux_err(status);
2128 if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
2129 status = mlme_set_request_sync(
2139 "error setting ieee address, MLME-SET.confirm status = %d",
2142 return link_to_linux_err(status);
2145 /* TODO: Should use MLME_START to set coord bit? */
2150 * ca8210_set_tx_power() - Sets the transmit power of the ca8210
2151 * @hw: ieee802154_hw of target ca8210
2152 * @mbm: Transmit power in mBm (dBm*100)
2154 * Return: 0 or linux error code
2156 static int ca8210_set_tx_power(struct ieee802154_hw *hw, s32 mbm)
2158 struct ca8210_priv *priv = hw->priv;
2161 return link_to_linux_err(
2162 mlme_set_request_sync(PHY_TRANSMIT_POWER, 0, 1, &mbm, priv->spi)
2167 * ca8210_set_cca_mode() - Sets the clear channel assessment mode of the ca8210
2168 * @hw: ieee802154_hw of target ca8210
2169 * @cca: CCA mode to set
2171 * Return: 0 or linux error code
2173 static int ca8210_set_cca_mode(
2174 struct ieee802154_hw *hw,
2175 const struct wpan_phy_cca *cca
2180 struct ca8210_priv *priv = hw->priv;
2182 cca_mode = cca->mode & 3;
2183 if (cca_mode == 3 && cca->opt == NL802154_CCA_OPT_ENERGY_CARRIER_OR) {
2184 /* cca_mode 0 == CS OR ED, 3 == CS AND ED */
2187 status = mlme_set_request_sync(
2197 "error setting cca mode, MLME-SET.confirm status = %d",
2201 return link_to_linux_err(status);
2205 * ca8210_set_cca_ed_level() - Sets the CCA ED level of the ca8210
2206 * @hw: ieee802154_hw of target ca8210
2207 * @level: ED level to set (in mbm)
2209 * Sets the minimum threshold of measured energy above which the ca8210 will
2210 * back off and retry a transmission.
2212 * Return: 0 or linux error code
2214 static int ca8210_set_cca_ed_level(struct ieee802154_hw *hw, s32 level)
2217 u8 ed_threshold = (level / 100) * 2 + 256;
2218 struct ca8210_priv *priv = hw->priv;
2220 status = hwme_set_request_sync(
2229 "error setting ed threshold, HWME-SET.confirm status = %d",
2233 return link_to_linux_err(status);
2237 * ca8210_set_csma_params() - Sets the CSMA parameters of the ca8210
2238 * @hw: ieee802154_hw of target ca8210
2239 * @min_be: Minimum backoff exponent when backing off a transmission
2240 * @max_be: Maximum backoff exponent when backing off a transmission
2241 * @retries: Number of times to retry after backing off
2243 * Return: 0 or linux error code
2245 static int ca8210_set_csma_params(
2246 struct ieee802154_hw *hw,
2253 struct ca8210_priv *priv = hw->priv;
2255 status = mlme_set_request_sync(MAC_MIN_BE, 0, 1, &min_be, priv->spi);
2259 "error setting min be, MLME-SET.confirm status = %d",
2262 return link_to_linux_err(status);
2264 status = mlme_set_request_sync(MAC_MAX_BE, 0, 1, &max_be, priv->spi);
2268 "error setting max be, MLME-SET.confirm status = %d",
2271 return link_to_linux_err(status);
2273 status = mlme_set_request_sync(
2274 MAC_MAX_CSMA_BACKOFFS,
2283 "error setting max csma backoffs, MLME-SET.confirm status = %d",
2287 return link_to_linux_err(status);
2291 * ca8210_set_frame_retries() - Sets the maximum frame retries of the ca8210
2292 * @hw: ieee802154_hw of target ca8210
2293 * @retries: Number of retries
2295 * Sets the number of times to retry a transmission if no acknowledgment was
2296 * received from the other end when one was requested.
2298 * Return: 0 or linux error code
2300 static int ca8210_set_frame_retries(struct ieee802154_hw *hw, s8 retries)
2303 struct ca8210_priv *priv = hw->priv;
2305 status = mlme_set_request_sync(
2306 MAC_MAX_FRAME_RETRIES,
2315 "error setting frame retries, MLME-SET.confirm status = %d",
2319 return link_to_linux_err(status);
2322 static int ca8210_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
2325 struct ca8210_priv *priv = hw->priv;
2327 status = mlme_set_request_sync(
2328 MAC_PROMISCUOUS_MODE,
2337 "error setting promiscuous mode, MLME-SET.confirm status = %d",
2341 priv->promiscuous = on;
2343 return link_to_linux_err(status);
2346 static const struct ieee802154_ops ca8210_phy_ops = {
2347 .start = ca8210_start,
2348 .stop = ca8210_stop,
2349 .xmit_async = ca8210_xmit_async,
2350 .ed = ca8210_get_ed,
2351 .set_channel = ca8210_set_channel,
2352 .set_hw_addr_filt = ca8210_set_hw_addr_filt,
2353 .set_txpower = ca8210_set_tx_power,
2354 .set_cca_mode = ca8210_set_cca_mode,
2355 .set_cca_ed_level = ca8210_set_cca_ed_level,
2356 .set_csma_params = ca8210_set_csma_params,
2357 .set_frame_retries = ca8210_set_frame_retries,
2358 .set_promiscuous_mode = ca8210_set_promiscuous_mode
2361 /* Test/EVBME Interface */
2364 * ca8210_test_int_open() - Opens the test interface to the userspace
2365 * @inodp: inode representation of file interface
2366 * @filp: file interface
2368 * Return: 0 or linux error code
2370 static int ca8210_test_int_open(struct inode *inodp, struct file *filp)
2372 struct ca8210_priv *priv = inodp->i_private;
2374 filp->private_data = priv;
2379 * ca8210_test_check_upstream() - Checks a command received from the upstream
2380 * testing interface for required action
2381 * @buf: Buffer containing command to check
2382 * @device_ref: Nondescript pointer to target device
2384 * Return: 0 or linux error code
2386 static int ca8210_test_check_upstream(u8 *buf, void *device_ref)
2389 u8 response[CA8210_SPI_BUF_SIZE];
2391 if (buf[0] == SPI_MLME_SET_REQUEST) {
2392 ret = tdme_checkpibattribute(buf[2], buf[4], buf + 5);
2394 response[0] = SPI_MLME_SET_CONFIRM;
2396 response[2] = IEEE802154_INVALID_PARAMETER;
2397 response[3] = buf[2];
2398 response[4] = buf[3];
2399 if (cascoda_api_upstream)
2400 cascoda_api_upstream(response, 5, device_ref);
2404 if (buf[0] == SPI_MLME_ASSOCIATE_REQUEST) {
2405 return tdme_channelinit(buf[2], device_ref);
2406 } else if (buf[0] == SPI_MLME_START_REQUEST) {
2407 return tdme_channelinit(buf[4], device_ref);
2409 (buf[0] == SPI_MLME_SET_REQUEST) &&
2410 (buf[2] == PHY_CURRENT_CHANNEL)
2412 return tdme_channelinit(buf[5], device_ref);
2414 (buf[0] == SPI_TDME_SET_REQUEST) &&
2415 (buf[2] == TDME_CHANNEL)
2417 return tdme_channelinit(buf[4], device_ref);
2419 (CA8210_MAC_WORKAROUNDS) &&
2420 (buf[0] == SPI_MLME_RESET_REQUEST) &&
2423 /* reset COORD Bit for Channel Filtering as Coordinator */
2424 return tdme_setsfr_request_sync(
2432 } /* End of EVBMECheckSerialCommand() */
2435 * ca8210_test_int_user_write() - Called by a process in userspace to send a
2436 * message to the ca8210 drivers
2437 * @filp: file interface
2438 * @in_buf: Buffer containing message to write
2439 * @len: length of message
2442 * Return: 0 or linux error code
2444 static ssize_t ca8210_test_int_user_write(
2446 const char __user *in_buf,
2452 struct ca8210_priv *priv = filp->private_data;
2453 u8 command[CA8210_SPI_BUF_SIZE];
2455 memset(command, SPI_IDLE, 6);
2456 if (len > CA8210_SPI_BUF_SIZE || len < 2) {
2459 "userspace requested erroneous write length (%zu)\n",
2465 ret = copy_from_user(command, in_buf, len);
2469 "%d bytes could not be copied from userspace\n",
2474 if (len != command[1] + 2) {
2477 "write len does not match packet length field\n"
2482 ret = ca8210_test_check_upstream(command, priv->spi);
2484 ret = ca8210_spi_exchange(
2491 /* effectively 0 bytes were written successfully */
2494 "spi exchange failed\n"
2498 if (command[0] & SPI_SYN)
2506 * ca8210_test_int_user_read() - Called by a process in userspace to read a
2507 * message from the ca8210 drivers
2508 * @filp: file interface
2509 * @buf: Buffer to write message to
2510 * @len: length of message to read (ignored)
2511 * @offp: file offset
2513 * If the O_NONBLOCK flag was set when opening the file then this function will
2514 * not block, i.e. it will return if the fifo is empty. Otherwise the function
2515 * will block, i.e. wait until new data arrives.
2517 * Return: number of bytes read
2519 static ssize_t ca8210_test_int_user_read(
2527 struct ca8210_priv *priv = filp->private_data;
2528 unsigned char *fifo_buffer;
2529 unsigned long bytes_not_copied;
2531 if (filp->f_flags & O_NONBLOCK) {
2532 /* Non-blocking mode */
2533 if (kfifo_is_empty(&priv->test.up_fifo))
2537 wait_event_interruptible(
2539 !kfifo_is_empty(&priv->test.up_fifo)
2543 if (kfifo_out(&priv->test.up_fifo, &fifo_buffer, 4) != 4) {
2546 "test_interface: Wrong number of elements popped from upstream fifo\n"
2550 cmdlen = fifo_buffer[1];
2551 bytes_not_copied = cmdlen + 2;
2553 bytes_not_copied = copy_to_user(buf, fifo_buffer, bytes_not_copied);
2554 if (bytes_not_copied > 0) {
2557 "%lu bytes could not be copied to user space!\n",
2562 dev_dbg(&priv->spi->dev, "test_interface: Cmd len = %d\n", cmdlen);
2564 dev_dbg(&priv->spi->dev, "test_interface: Read\n");
2565 for (i = 0; i < cmdlen + 2; i++)
2566 dev_dbg(&priv->spi->dev, "%#03x\n", fifo_buffer[i]);
2574 * ca8210_test_int_ioctl() - Called by a process in userspace to enact an
2576 * @filp: file interface
2577 * @ioctl_num: which action to enact
2578 * @ioctl_param: arbitrary parameter for the action
2582 static long ca8210_test_int_ioctl(
2584 unsigned int ioctl_num,
2585 unsigned long ioctl_param
2588 struct ca8210_priv *priv = filp->private_data;
2590 switch (ioctl_num) {
2591 case CA8210_IOCTL_HARD_RESET:
2592 ca8210_reset_send(priv->spi, ioctl_param);
2601 * ca8210_test_int_poll() - Called by a process in userspace to determine which
2602 * actions are currently possible for the file
2603 * @filp: file interface
2604 * @ptable: poll table
2606 * Return: set of poll return flags
2608 static __poll_t ca8210_test_int_poll(
2610 struct poll_table_struct *ptable
2613 __poll_t return_flags = 0;
2614 struct ca8210_priv *priv = filp->private_data;
2616 poll_wait(filp, &priv->test.readq, ptable);
2617 if (!kfifo_is_empty(&priv->test.up_fifo))
2618 return_flags |= (EPOLLIN | EPOLLRDNORM);
2619 if (wait_event_interruptible(
2621 !kfifo_is_empty(&priv->test.up_fifo))) {
2624 return return_flags;
2627 static const struct file_operations test_int_fops = {
2628 .read = ca8210_test_int_user_read,
2629 .write = ca8210_test_int_user_write,
2630 .open = ca8210_test_int_open,
2632 .unlocked_ioctl = ca8210_test_int_ioctl,
2633 .poll = ca8210_test_int_poll
2639 * ca8210_get_platform_data() - Populate a ca8210_platform_data object
2640 * @spi_device: Pointer to ca8210 spi device object to get data for
2641 * @pdata: Pointer to ca8210_platform_data object to populate
2643 * Return: 0 or linux error code
2645 static int ca8210_get_platform_data(
2646 struct spi_device *spi_device,
2647 struct ca8210_platform_data *pdata
2652 if (!spi_device->dev.of_node)
2655 pdata->extclockenable = of_property_read_bool(
2656 spi_device->dev.of_node,
2659 if (pdata->extclockenable) {
2660 ret = of_property_read_u32(
2661 spi_device->dev.of_node,
2663 &pdata->extclockfreq
2668 ret = of_property_read_u32(
2669 spi_device->dev.of_node,
2671 &pdata->extclockgpio
2679 * ca8210_config_extern_clk() - Configure the external clock provided by the
2681 * @pdata: Pointer to ca8210_platform_data containing clock parameters
2682 * @spi: Pointer to target ca8210 spi device
2683 * @on: True to turn the clock on, false to turn off
2685 * The external clock is configured with a frequency and output pin taken from
2686 * the platform data.
2688 * Return: 0 or linux error code
2690 static int ca8210_config_extern_clk(
2691 struct ca8210_platform_data *pdata,
2692 struct spi_device *spi,
2699 dev_info(&spi->dev, "Switching external clock on\n");
2700 switch (pdata->extclockfreq) {
2717 dev_crit(&spi->dev, "Invalid extclock-freq\n");
2720 clkparam[1] = pdata->extclockgpio;
2722 dev_info(&spi->dev, "Switching external clock off\n");
2723 clkparam[0] = 0; /* off */
2726 return link_to_linux_err(
2727 hwme_set_request_sync(HWME_SYSCLKOUT, 2, clkparam, spi)
2732 * ca8210_register_ext_clock() - Register ca8210's external clock with kernel
2733 * @spi: Pointer to target ca8210 spi device
2735 * Return: 0 or linux error code
2737 static int ca8210_register_ext_clock(struct spi_device *spi)
2739 struct device_node *np = spi->dev.of_node;
2740 struct ca8210_priv *priv = spi_get_drvdata(spi);
2741 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2747 priv->clk = clk_register_fixed_rate(
2755 if (IS_ERR(priv->clk)) {
2756 dev_crit(&spi->dev, "Failed to register external clk\n");
2757 return PTR_ERR(priv->clk);
2759 ret = of_clk_add_provider(np, of_clk_src_simple_get, priv->clk);
2761 clk_unregister(priv->clk);
2764 "Failed to register external clock as clock provider\n"
2767 dev_info(&spi->dev, "External clock set as clock provider\n");
2774 * ca8210_unregister_ext_clock() - Unregister ca8210's external clock with
2776 * @spi: Pointer to target ca8210 spi device
2778 static void ca8210_unregister_ext_clock(struct spi_device *spi)
2780 struct ca8210_priv *priv = spi_get_drvdata(spi);
2785 of_clk_del_provider(spi->dev.of_node);
2786 clk_unregister(priv->clk);
2787 dev_info(&spi->dev, "External clock unregistered\n");
2791 * ca8210_reset_init() - Initialise the reset input to the ca8210
2792 * @spi: Pointer to target ca8210 spi device
2794 * Return: 0 or linux error code
2796 static int ca8210_reset_init(struct spi_device *spi)
2799 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2801 pdata->gpio_reset = of_get_named_gpio(
2807 ret = gpio_direction_output(pdata->gpio_reset, 1);
2811 "Reset GPIO %d did not set to output mode\n",
2820 * ca8210_interrupt_init() - Initialise the irq output from the ca8210
2821 * @spi: Pointer to target ca8210 spi device
2823 * Return: 0 or linux error code
2825 static int ca8210_interrupt_init(struct spi_device *spi)
2828 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2830 pdata->gpio_irq = of_get_named_gpio(
2836 pdata->irq_id = gpio_to_irq(pdata->gpio_irq);
2837 if (pdata->irq_id < 0) {
2840 "Could not get irq for gpio pin %d\n",
2843 gpio_free(pdata->gpio_irq);
2844 return pdata->irq_id;
2849 ca8210_interrupt_handler,
2850 IRQF_TRIGGER_FALLING,
2852 spi_get_drvdata(spi)
2855 dev_crit(&spi->dev, "request_irq %d failed\n", pdata->irq_id);
2856 gpio_unexport(pdata->gpio_irq);
2857 gpio_free(pdata->gpio_irq);
2864 * ca8210_dev_com_init() - Initialise the spi communication component
2865 * @priv: Pointer to private data structure
2867 * Return: 0 or linux error code
2869 static int ca8210_dev_com_init(struct ca8210_priv *priv)
2871 priv->mlme_workqueue = alloc_ordered_workqueue(
2875 if (!priv->mlme_workqueue) {
2876 dev_crit(&priv->spi->dev, "alloc of mlme_workqueue failed!\n");
2880 priv->irq_workqueue = alloc_ordered_workqueue(
2881 "ca8210 irq worker",
2884 if (!priv->irq_workqueue) {
2885 dev_crit(&priv->spi->dev, "alloc of irq_workqueue failed!\n");
2886 destroy_workqueue(priv->mlme_workqueue);
2894 * ca8210_dev_com_clear() - Deinitialise the spi communication component
2895 * @priv: Pointer to private data structure
2897 static void ca8210_dev_com_clear(struct ca8210_priv *priv)
2899 destroy_workqueue(priv->mlme_workqueue);
2900 destroy_workqueue(priv->irq_workqueue);
2903 #define CA8210_MAX_TX_POWERS (9)
2904 static const s32 ca8210_tx_powers[CA8210_MAX_TX_POWERS] = {
2905 800, 700, 600, 500, 400, 300, 200, 100, 0
2908 #define CA8210_MAX_ED_LEVELS (21)
2909 static const s32 ca8210_ed_levels[CA8210_MAX_ED_LEVELS] = {
2910 -10300, -10250, -10200, -10150, -10100, -10050, -10000, -9950, -9900,
2911 -9850, -9800, -9750, -9700, -9650, -9600, -9550, -9500, -9450, -9400,
2916 * ca8210_hw_setup() - Populate the ieee802154_hw phy attributes with the
2918 * @ca8210_hw: Pointer to ieee802154_hw to populate
2920 static void ca8210_hw_setup(struct ieee802154_hw *ca8210_hw)
2922 /* Support channels 11-26 */
2923 ca8210_hw->phy->supported.channels[0] = CA8210_VALID_CHANNELS;
2924 ca8210_hw->phy->supported.tx_powers_size = CA8210_MAX_TX_POWERS;
2925 ca8210_hw->phy->supported.tx_powers = ca8210_tx_powers;
2926 ca8210_hw->phy->supported.cca_ed_levels_size = CA8210_MAX_ED_LEVELS;
2927 ca8210_hw->phy->supported.cca_ed_levels = ca8210_ed_levels;
2928 ca8210_hw->phy->current_channel = 18;
2929 ca8210_hw->phy->current_page = 0;
2930 ca8210_hw->phy->transmit_power = 800;
2931 ca8210_hw->phy->cca.mode = NL802154_CCA_ENERGY_CARRIER;
2932 ca8210_hw->phy->cca.opt = NL802154_CCA_OPT_ENERGY_CARRIER_AND;
2933 ca8210_hw->phy->cca_ed_level = -9800;
2934 ca8210_hw->phy->symbol_duration = 16;
2935 ca8210_hw->phy->lifs_period = 40 * ca8210_hw->phy->symbol_duration;
2936 ca8210_hw->phy->sifs_period = 12 * ca8210_hw->phy->symbol_duration;
2938 IEEE802154_HW_AFILT |
2939 IEEE802154_HW_OMIT_CKSUM |
2940 IEEE802154_HW_FRAME_RETRIES |
2941 IEEE802154_HW_PROMISCUOUS |
2942 IEEE802154_HW_CSMA_PARAMS;
2943 ca8210_hw->phy->flags =
2944 WPAN_PHY_FLAG_TXPOWER |
2945 WPAN_PHY_FLAG_CCA_ED_LEVEL |
2946 WPAN_PHY_FLAG_CCA_MODE;
2950 * ca8210_test_interface_init() - Initialise the test file interface
2951 * @priv: Pointer to private data structure
2953 * Provided as an alternative to the standard linux network interface, the test
2954 * interface exposes a file in the filesystem (ca8210_test) that allows
2955 * 802.15.4 SAP Commands and Cascoda EVBME commands to be sent directly to
2958 * Return: 0 or linux error code
2960 static int ca8210_test_interface_init(struct ca8210_priv *priv)
2962 struct ca8210_test *test = &priv->test;
2969 priv->spi->master->bus_num,
2970 priv->spi->chip_select
2973 test->ca8210_dfs_spi_int = debugfs_create_file(
2975 0600, /* S_IRUSR | S_IWUSR */
2981 debugfs_create_symlink("ca8210", NULL, node_name);
2982 init_waitqueue_head(&test->readq);
2985 CA8210_TEST_INT_FIFO_SIZE,
2991 * ca8210_test_interface_clear() - Deinitialise the test file interface
2992 * @priv: Pointer to private data structure
2994 static void ca8210_test_interface_clear(struct ca8210_priv *priv)
2996 struct ca8210_test *test = &priv->test;
2998 debugfs_remove(test->ca8210_dfs_spi_int);
2999 kfifo_free(&test->up_fifo);
3000 dev_info(&priv->spi->dev, "Test interface removed\n");
3004 * ca8210_remove() - Shut down a ca8210 upon being disconnected
3005 * @spi_device: Pointer to spi device data structure
3007 * Return: 0 or linux error code
3009 static void ca8210_remove(struct spi_device *spi_device)
3011 struct ca8210_priv *priv;
3012 struct ca8210_platform_data *pdata;
3014 dev_info(&spi_device->dev, "Removing ca8210\n");
3016 pdata = spi_device->dev.platform_data;
3018 if (pdata->extclockenable) {
3019 ca8210_unregister_ext_clock(spi_device);
3020 ca8210_config_extern_clk(pdata, spi_device, 0);
3022 free_irq(pdata->irq_id, spi_device->dev.driver_data);
3024 spi_device->dev.platform_data = NULL;
3026 /* get spi_device private data */
3027 priv = spi_get_drvdata(spi_device);
3031 "sync_down = %d, sync_up = %d\n",
3035 ca8210_dev_com_clear(spi_device->dev.driver_data);
3037 if (priv->hw_registered)
3038 ieee802154_unregister_hw(priv->hw);
3039 ieee802154_free_hw(priv->hw);
3043 "Unregistered & freed ieee802154_hw.\n"
3046 if (IS_ENABLED(CONFIG_IEEE802154_CA8210_DEBUGFS))
3047 ca8210_test_interface_clear(priv);
3052 * ca8210_probe() - Set up a connected ca8210 upon being detected by the system
3053 * @spi_device: Pointer to spi device data structure
3055 * Return: 0 or linux error code
3057 static int ca8210_probe(struct spi_device *spi_device)
3059 struct ca8210_priv *priv;
3060 struct ieee802154_hw *hw;
3061 struct ca8210_platform_data *pdata;
3064 dev_info(&spi_device->dev, "Inserting ca8210\n");
3066 /* allocate ieee802154_hw and private data */
3067 hw = ieee802154_alloc_hw(sizeof(struct ca8210_priv), &ca8210_phy_ops);
3069 dev_crit(&spi_device->dev, "ieee802154_alloc_hw failed\n");
3076 priv->spi = spi_device;
3077 hw->parent = &spi_device->dev;
3078 spin_lock_init(&priv->lock);
3079 priv->async_tx_pending = false;
3080 priv->hw_registered = false;
3082 priv->sync_down = 0;
3083 priv->promiscuous = false;
3085 init_completion(&priv->ca8210_is_awake);
3086 init_completion(&priv->spi_transfer_complete);
3087 init_completion(&priv->sync_exchange_complete);
3088 spi_set_drvdata(priv->spi, priv);
3089 if (IS_ENABLED(CONFIG_IEEE802154_CA8210_DEBUGFS)) {
3090 cascoda_api_upstream = ca8210_test_int_driver_write;
3091 ca8210_test_interface_init(priv);
3093 cascoda_api_upstream = NULL;
3095 ca8210_hw_setup(hw);
3096 ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
3098 pdata = kmalloc(sizeof(*pdata), GFP_KERNEL);
3104 priv->spi->dev.platform_data = pdata;
3105 ret = ca8210_get_platform_data(priv->spi, pdata);
3107 dev_crit(&spi_device->dev, "ca8210_get_platform_data failed\n");
3111 ret = ca8210_dev_com_init(priv);
3113 dev_crit(&spi_device->dev, "ca8210_dev_com_init failed\n");
3116 ret = ca8210_reset_init(priv->spi);
3118 dev_crit(&spi_device->dev, "ca8210_reset_init failed\n");
3122 ret = ca8210_interrupt_init(priv->spi);
3124 dev_crit(&spi_device->dev, "ca8210_interrupt_init failed\n");
3130 ca8210_reset_send(priv->spi, 1);
3132 ret = tdme_chipinit(priv->spi);
3134 dev_crit(&spi_device->dev, "tdme_chipinit failed\n");
3138 if (pdata->extclockenable) {
3139 ret = ca8210_config_extern_clk(pdata, priv->spi, 1);
3143 "ca8210_config_extern_clk failed\n"
3147 ret = ca8210_register_ext_clock(priv->spi);
3151 "ca8210_register_ext_clock failed\n"
3157 ret = ieee802154_register_hw(hw);
3159 dev_crit(&spi_device->dev, "ieee802154_register_hw failed\n");
3162 priv->hw_registered = true;
3166 msleep(100); /* wait for pending spi transfers to complete */
3167 ca8210_remove(spi_device);
3168 return link_to_linux_err(ret);
3171 static const struct of_device_id ca8210_of_ids[] = {
3172 {.compatible = "cascoda,ca8210", },
3175 MODULE_DEVICE_TABLE(of, ca8210_of_ids);
3177 static struct spi_driver ca8210_spi_driver = {
3179 .name = DRIVER_NAME,
3180 .owner = THIS_MODULE,
3181 .of_match_table = of_match_ptr(ca8210_of_ids),
3183 .probe = ca8210_probe,
3184 .remove = ca8210_remove
3187 module_spi_driver(ca8210_spi_driver);
3189 MODULE_AUTHOR("Harry Morris <h.morris@cascoda.com>");
3190 MODULE_DESCRIPTION("CA-8210 SoftMAC driver");
3191 MODULE_LICENSE("Dual BSD/GPL");
3192 MODULE_VERSION("1.0");