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 /* MAC status enumerations */
93 #define MAC_SUCCESS (0x00)
94 #define MAC_ERROR (0x01)
95 #define MAC_CANCELLED (0x02)
96 #define MAC_READY_FOR_POLL (0x03)
97 #define MAC_COUNTER_ERROR (0xDB)
98 #define MAC_IMPROPER_KEY_TYPE (0xDC)
99 #define MAC_IMPROPER_SECURITY_LEVEL (0xDD)
100 #define MAC_UNSUPPORTED_LEGACY (0xDE)
101 #define MAC_UNSUPPORTED_SECURITY (0xDF)
102 #define MAC_BEACON_LOST (0xE0)
103 #define MAC_CHANNEL_ACCESS_FAILURE (0xE1)
104 #define MAC_DENIED (0xE2)
105 #define MAC_DISABLE_TRX_FAILURE (0xE3)
106 #define MAC_SECURITY_ERROR (0xE4)
107 #define MAC_FRAME_TOO_LONG (0xE5)
108 #define MAC_INVALID_GTS (0xE6)
109 #define MAC_INVALID_HANDLE (0xE7)
110 #define MAC_INVALID_PARAMETER (0xE8)
111 #define MAC_NO_ACK (0xE9)
112 #define MAC_NO_BEACON (0xEA)
113 #define MAC_NO_DATA (0xEB)
114 #define MAC_NO_SHORT_ADDRESS (0xEC)
115 #define MAC_OUT_OF_CAP (0xED)
116 #define MAC_PAN_ID_CONFLICT (0xEE)
117 #define MAC_REALIGNMENT (0xEF)
118 #define MAC_TRANSACTION_EXPIRED (0xF0)
119 #define MAC_TRANSACTION_OVERFLOW (0xF1)
120 #define MAC_TX_ACTIVE (0xF2)
121 #define MAC_UNAVAILABLE_KEY (0xF3)
122 #define MAC_UNSUPPORTED_ATTRIBUTE (0xF4)
123 #define MAC_INVALID_ADDRESS (0xF5)
124 #define MAC_ON_TIME_TOO_LONG (0xF6)
125 #define MAC_PAST_TIME (0xF7)
126 #define MAC_TRACKING_OFF (0xF8)
127 #define MAC_INVALID_INDEX (0xF9)
128 #define MAC_LIMIT_REACHED (0xFA)
129 #define MAC_READ_ONLY (0xFB)
130 #define MAC_SCAN_IN_PROGRESS (0xFC)
131 #define MAC_SUPERFRAME_OVERLAP (0xFD)
132 #define MAC_SYSTEM_ERROR (0xFF)
134 /* HWME attribute IDs */
135 #define HWME_EDTHRESHOLD (0x04)
136 #define HWME_EDVALUE (0x06)
137 #define HWME_SYSCLKOUT (0x0F)
138 #define HWME_LQILIMIT (0x11)
140 /* TDME attribute IDs */
141 #define TDME_CHANNEL (0x00)
142 #define TDME_ATM_CONFIG (0x06)
144 #define MAX_HWME_ATTRIBUTE_SIZE 16
145 #define MAX_TDME_ATTRIBUTE_SIZE 2
147 /* PHY/MAC PIB Attribute Enumerations */
148 #define PHY_CURRENT_CHANNEL (0x00)
149 #define PHY_TRANSMIT_POWER (0x02)
150 #define PHY_CCA_MODE (0x03)
151 #define MAC_ASSOCIATION_PERMIT (0x41)
152 #define MAC_AUTO_REQUEST (0x42)
153 #define MAC_BATT_LIFE_EXT (0x43)
154 #define MAC_BATT_LIFE_EXT_PERIODS (0x44)
155 #define MAC_BEACON_PAYLOAD (0x45)
156 #define MAC_BEACON_PAYLOAD_LENGTH (0x46)
157 #define MAC_BEACON_ORDER (0x47)
158 #define MAC_GTS_PERMIT (0x4d)
159 #define MAC_MAX_CSMA_BACKOFFS (0x4e)
160 #define MAC_MIN_BE (0x4f)
161 #define MAC_PAN_ID (0x50)
162 #define MAC_PROMISCUOUS_MODE (0x51)
163 #define MAC_RX_ON_WHEN_IDLE (0x52)
164 #define MAC_SHORT_ADDRESS (0x53)
165 #define MAC_SUPERFRAME_ORDER (0x54)
166 #define MAC_ASSOCIATED_PAN_COORD (0x56)
167 #define MAC_MAX_BE (0x57)
168 #define MAC_MAX_FRAME_RETRIES (0x59)
169 #define MAC_RESPONSE_WAIT_TIME (0x5A)
170 #define MAC_SECURITY_ENABLED (0x5D)
172 #define MAC_AUTO_REQUEST_SECURITY_LEVEL (0x78)
173 #define MAC_AUTO_REQUEST_KEY_ID_MODE (0x79)
175 #define NS_IEEE_ADDRESS (0xFF) /* Non-standard IEEE address */
177 /* MAC Address Mode Definitions */
178 #define MAC_MODE_NO_ADDR (0x00)
179 #define MAC_MODE_SHORT_ADDR (0x02)
180 #define MAC_MODE_LONG_ADDR (0x03)
183 #define MAX_BEACON_OVERHEAD (75)
184 #define MAX_BEACON_PAYLOAD_LENGTH (IEEE802154_MTU - MAX_BEACON_OVERHEAD)
186 #define MAX_ATTRIBUTE_SIZE (122)
187 #define MAX_DATA_SIZE (114)
189 #define CA8210_VALID_CHANNELS (0x07FFF800)
191 /* MAC workarounds for V1.1 and MPW silicon (V0.x) */
192 #define CA8210_MAC_WORKAROUNDS (0)
193 #define CA8210_MAC_MPW (0)
195 /* memory manipulation macros */
196 #define LS_BYTE(x) ((u8)((x) & 0xFF))
197 #define MS_BYTE(x) ((u8)(((x) >> 8) & 0xFF))
199 /* message ID codes in SPI commands */
201 #define MCPS_DATA_REQUEST (0x00)
202 #define MLME_ASSOCIATE_REQUEST (0x02)
203 #define MLME_ASSOCIATE_RESPONSE (0x03)
204 #define MLME_DISASSOCIATE_REQUEST (0x04)
205 #define MLME_GET_REQUEST (0x05)
206 #define MLME_ORPHAN_RESPONSE (0x06)
207 #define MLME_RESET_REQUEST (0x07)
208 #define MLME_RX_ENABLE_REQUEST (0x08)
209 #define MLME_SCAN_REQUEST (0x09)
210 #define MLME_SET_REQUEST (0x0A)
211 #define MLME_START_REQUEST (0x0B)
212 #define MLME_POLL_REQUEST (0x0D)
213 #define HWME_SET_REQUEST (0x0E)
214 #define HWME_GET_REQUEST (0x0F)
215 #define TDME_SETSFR_REQUEST (0x11)
216 #define TDME_GETSFR_REQUEST (0x12)
217 #define TDME_SET_REQUEST (0x14)
219 #define MCPS_DATA_INDICATION (0x00)
220 #define MCPS_DATA_CONFIRM (0x01)
221 #define MLME_RESET_CONFIRM (0x0A)
222 #define MLME_SET_CONFIRM (0x0E)
223 #define MLME_START_CONFIRM (0x0F)
224 #define HWME_SET_CONFIRM (0x12)
225 #define HWME_GET_CONFIRM (0x13)
226 #define HWME_WAKEUP_INDICATION (0x15)
227 #define TDME_SETSFR_CONFIRM (0x17)
229 /* SPI command IDs */
230 /* bit indicating a confirm or indication from slave to master */
231 #define SPI_S2M (0x20)
232 /* bit indicating a synchronous message */
233 #define SPI_SYN (0x40)
235 /* SPI command definitions */
236 #define SPI_IDLE (0xFF)
237 #define SPI_NACK (0xF0)
239 #define SPI_MCPS_DATA_REQUEST (MCPS_DATA_REQUEST)
240 #define SPI_MCPS_DATA_INDICATION (MCPS_DATA_INDICATION + SPI_S2M)
241 #define SPI_MCPS_DATA_CONFIRM (MCPS_DATA_CONFIRM + SPI_S2M)
243 #define SPI_MLME_ASSOCIATE_REQUEST (MLME_ASSOCIATE_REQUEST)
244 #define SPI_MLME_RESET_REQUEST (MLME_RESET_REQUEST + SPI_SYN)
245 #define SPI_MLME_SET_REQUEST (MLME_SET_REQUEST + SPI_SYN)
246 #define SPI_MLME_START_REQUEST (MLME_START_REQUEST + SPI_SYN)
247 #define SPI_MLME_RESET_CONFIRM (MLME_RESET_CONFIRM + SPI_S2M + SPI_SYN)
248 #define SPI_MLME_SET_CONFIRM (MLME_SET_CONFIRM + SPI_S2M + SPI_SYN)
249 #define SPI_MLME_START_CONFIRM (MLME_START_CONFIRM + SPI_S2M + SPI_SYN)
251 #define SPI_HWME_SET_REQUEST (HWME_SET_REQUEST + SPI_SYN)
252 #define SPI_HWME_GET_REQUEST (HWME_GET_REQUEST + SPI_SYN)
253 #define SPI_HWME_SET_CONFIRM (HWME_SET_CONFIRM + SPI_S2M + SPI_SYN)
254 #define SPI_HWME_GET_CONFIRM (HWME_GET_CONFIRM + SPI_S2M + SPI_SYN)
255 #define SPI_HWME_WAKEUP_INDICATION (HWME_WAKEUP_INDICATION + SPI_S2M)
257 #define SPI_TDME_SETSFR_REQUEST (TDME_SETSFR_REQUEST + SPI_SYN)
258 #define SPI_TDME_SET_REQUEST (TDME_SET_REQUEST + SPI_SYN)
259 #define SPI_TDME_SETSFR_CONFIRM (TDME_SETSFR_CONFIRM + SPI_S2M + SPI_SYN)
261 /* TDME SFR addresses */
263 #define CA8210_SFR_PACFG (0xB1)
264 #define CA8210_SFR_MACCON (0xD8)
265 #define CA8210_SFR_PACFGIB (0xFE)
267 #define CA8210_SFR_LOTXCAL (0xBF)
268 #define CA8210_SFR_PTHRH (0xD1)
269 #define CA8210_SFR_PRECFG (0xD3)
270 #define CA8210_SFR_LNAGX40 (0xE1)
271 #define CA8210_SFR_LNAGX41 (0xE2)
272 #define CA8210_SFR_LNAGX42 (0xE3)
273 #define CA8210_SFR_LNAGX43 (0xE4)
274 #define CA8210_SFR_LNAGX44 (0xE5)
275 #define CA8210_SFR_LNAGX45 (0xE6)
276 #define CA8210_SFR_LNAGX46 (0xE7)
277 #define CA8210_SFR_LNAGX47 (0xE9)
279 #define PACFGIB_DEFAULT_CURRENT (0x3F)
280 #define PTHRH_DEFAULT_THRESHOLD (0x5A)
281 #define LNAGX40_DEFAULT_GAIN (0x29) /* 10dB */
282 #define LNAGX41_DEFAULT_GAIN (0x54) /* 21dB */
283 #define LNAGX42_DEFAULT_GAIN (0x6C) /* 27dB */
284 #define LNAGX43_DEFAULT_GAIN (0x7A) /* 30dB */
285 #define LNAGX44_DEFAULT_GAIN (0x84) /* 33dB */
286 #define LNAGX45_DEFAULT_GAIN (0x8B) /* 34dB */
287 #define LNAGX46_DEFAULT_GAIN (0x92) /* 36dB */
288 #define LNAGX47_DEFAULT_GAIN (0x96) /* 37dB */
290 #define CA8210_IOCTL_HARD_RESET (0x00)
295 * struct cas_control - spi transfer structure
296 * @msg: spi_message for each exchange
297 * @transfer: spi_transfer for each exchange
298 * @tx_buf: source array for transmission
299 * @tx_in_buf: array storing bytes received during transmission
300 * @priv: pointer to private data
302 * This structure stores all the necessary data passed around during a single
306 struct spi_message msg;
307 struct spi_transfer transfer;
309 u8 tx_buf[CA8210_SPI_BUF_SIZE];
310 u8 tx_in_buf[CA8210_SPI_BUF_SIZE];
312 struct ca8210_priv *priv;
316 * struct ca8210_test - ca8210 test interface structure
317 * @ca8210_dfs_spi_int: pointer to the entry in the debug fs for this device
318 * @up_fifo: fifo for upstream messages
320 * This structure stores all the data pertaining to the debug interface
323 struct dentry *ca8210_dfs_spi_int;
324 struct kfifo up_fifo;
325 wait_queue_head_t readq;
329 * struct ca8210_priv - ca8210 private data structure
330 * @spi: pointer to the ca8210 spi device object
331 * @hw: pointer to the ca8210 ieee802154_hw object
332 * @hw_registered: true if hw has been registered with ieee802154
333 * @lock: spinlock protecting the private data area
334 * @mlme_workqueue: workqueue for triggering MLME Reset
335 * @irq_workqueue: workqueue for irq processing
336 * @tx_skb: current socket buffer to transmit
337 * @nextmsduhandle: msdu handle to pass to the 15.4 MAC layer for the
339 * @clk: external clock provided by the ca8210
340 * @last_dsn: sequence number of last data packet received, for
342 * @test: test interface data section for this instance
343 * @async_tx_pending: true if an asynchronous transmission was started and
345 * @sync_command_response: pointer to buffer to fill with sync response
346 * @ca8210_is_awake: nonzero if ca8210 is initialised, ready for comms
347 * @sync_down: counts number of downstream synchronous commands
348 * @sync_up: counts number of upstream synchronous commands
349 * @spi_transfer_complete completion object for a single spi_transfer
350 * @sync_exchange_complete completion object for a complete synchronous API
352 * @promiscuous whether the ca8210 is in promiscuous mode or not
353 * @retries: records how many times the current pending spi
354 * transfer has been retried
357 struct spi_device *spi;
358 struct ieee802154_hw *hw;
361 struct workqueue_struct *mlme_workqueue;
362 struct workqueue_struct *irq_workqueue;
363 struct sk_buff *tx_skb;
367 struct ca8210_test test;
368 bool async_tx_pending;
369 u8 *sync_command_response;
370 struct completion ca8210_is_awake;
371 int sync_down, sync_up;
372 struct completion spi_transfer_complete, sync_exchange_complete;
378 * struct work_priv_container - link between a work object and the relevant
379 * device's private data
380 * @work: work object being executed
381 * @priv: device's private data section
384 struct work_priv_container {
385 struct work_struct work;
386 struct ca8210_priv *priv;
390 * struct ca8210_platform_data - ca8210 platform data structure
391 * @extclockenable: true if the external clock is to be enabled
392 * @extclockfreq: frequency of the external clock
393 * @extclockgpio: ca8210 output gpio of the external clock
394 * @gpio_reset: gpio number of ca8210 reset line
395 * @gpio_irq: gpio number of ca8210 interrupt line
396 * @irq_id: identifier for the ca8210 irq
399 struct ca8210_platform_data {
401 unsigned int extclockfreq;
402 unsigned int extclockgpio;
409 * struct fulladdr - full MAC addressing information structure
410 * @mode: address mode (none, short, extended)
411 * @pan_id: 16-bit LE pan id
412 * @address: LE address, variable length as specified by mode
422 * union macaddr: generic MAC address container
423 * @short_addr: 16-bit short address
424 * @ieee_address: 64-bit extended address as LE byte array
433 * struct secspec: security specification for SAP commands
434 * @security_level: 0-7, controls level of authentication & encryption
435 * @key_id_mode: 0-3, specifies how to obtain key
436 * @key_source: extended key retrieval data
437 * @key_index: single-byte key identifier
447 /* downlink functions parameter set definitions */
448 struct mcps_data_request_pset {
454 u8 msdu[MAX_DATA_SIZE];
457 struct mlme_set_request_pset {
459 u8 pib_attribute_index;
460 u8 pib_attribute_length;
461 u8 pib_attribute_value[MAX_ATTRIBUTE_SIZE];
464 struct hwme_set_request_pset {
466 u8 hw_attribute_length;
467 u8 hw_attribute_value[MAX_HWME_ATTRIBUTE_SIZE];
470 struct hwme_get_request_pset {
474 struct tdme_setsfr_request_pset {
480 /* uplink functions parameter set definitions */
481 struct hwme_set_confirm_pset {
486 struct hwme_get_confirm_pset {
489 u8 hw_attribute_length;
490 u8 hw_attribute_value[MAX_HWME_ATTRIBUTE_SIZE];
493 struct tdme_setsfr_confirm_pset {
503 struct mcps_data_request_pset data_req;
504 struct mlme_set_request_pset set_req;
505 struct hwme_set_request_pset hwme_set_req;
506 struct hwme_get_request_pset hwme_get_req;
507 struct tdme_setsfr_request_pset tdme_set_sfr_req;
508 struct hwme_set_confirm_pset hwme_set_cnf;
509 struct hwme_get_confirm_pset hwme_get_cnf;
510 struct tdme_setsfr_confirm_pset tdme_set_sfr_cnf;
519 u8 bias_current_trim : 3;
520 u8 /* reserved */ : 1;
521 u8 buffer_capacitor_trim : 3;
527 struct preamble_cfg_sfr {
528 u8 timeout_symbols : 3;
529 u8 acquisition_symbols : 3;
530 u8 search_symbols : 2;
533 static int (*cascoda_api_upstream)(
540 * link_to_linux_err() - Translates an 802.15.4 return code into the closest
542 * @link_status: 802.15.4 status code
544 * Return: 0 or Linux error code
546 static int link_to_linux_err(int link_status)
548 if (link_status < 0) {
549 /* status is already a Linux code */
552 switch (link_status) {
554 case MAC_REALIGNMENT:
556 case MAC_IMPROPER_KEY_TYPE:
557 return -EKEYREJECTED;
558 case MAC_IMPROPER_SECURITY_LEVEL:
559 case MAC_UNSUPPORTED_LEGACY:
562 case MAC_BEACON_LOST:
566 case MAC_CHANNEL_ACCESS_FAILURE:
568 case MAC_SCAN_IN_PROGRESS:
570 case MAC_DISABLE_TRX_FAILURE:
573 case MAC_FRAME_TOO_LONG:
575 case MAC_INVALID_GTS:
578 case MAC_INVALID_HANDLE:
580 case MAC_INVALID_PARAMETER:
581 case MAC_UNSUPPORTED_ATTRIBUTE:
582 case MAC_ON_TIME_TOO_LONG:
583 case MAC_INVALID_INDEX:
587 case MAC_NO_SHORT_ADDRESS:
589 case MAC_PAN_ID_CONFLICT:
591 case MAC_TRANSACTION_EXPIRED:
593 case MAC_TRANSACTION_OVERFLOW:
595 case MAC_UNAVAILABLE_KEY:
597 case MAC_INVALID_ADDRESS:
599 case MAC_TRACKING_OFF:
600 case MAC_SUPERFRAME_OVERLAP:
602 case MAC_LIMIT_REACHED:
612 * ca8210_test_int_driver_write() - Writes a message to the test interface to be
613 * read by the userspace
614 * @buf: Buffer containing upstream message
615 * @len: length of message to write
616 * @spi: SPI device of message originator
618 * Return: 0 or linux error code
620 static int ca8210_test_int_driver_write(
626 struct ca8210_priv *priv = spi_get_drvdata(spi);
627 struct ca8210_test *test = &priv->test;
633 "test_interface: Buffering upstream message:\n"
635 for (i = 0; i < len; i++)
636 dev_dbg(&priv->spi->dev, "%#03x\n", buf[i]);
638 fifo_buffer = kmemdup(buf, len, GFP_KERNEL);
641 kfifo_in(&test->up_fifo, &fifo_buffer, 4);
642 wake_up_interruptible(&priv->test.readq);
649 static int ca8210_net_rx(
650 struct ieee802154_hw *hw,
654 static u8 mlme_reset_request_sync(
658 static int ca8210_spi_transfer(
659 struct spi_device *spi,
665 * ca8210_reset_send() - Hard resets the ca8210 for a given time
666 * @spi: Pointer to target ca8210 spi device
667 * @ms: Milliseconds to hold the reset line low for
669 static void ca8210_reset_send(struct spi_device *spi, unsigned int ms)
671 struct ca8210_platform_data *pdata = spi->dev.platform_data;
672 struct ca8210_priv *priv = spi_get_drvdata(spi);
675 gpio_set_value(pdata->gpio_reset, 0);
676 reinit_completion(&priv->ca8210_is_awake);
678 gpio_set_value(pdata->gpio_reset, 1);
679 priv->promiscuous = false;
681 /* Wait until wakeup indication seen */
682 status = wait_for_completion_interruptible_timeout(
683 &priv->ca8210_is_awake,
684 msecs_to_jiffies(CA8210_SYNC_TIMEOUT)
689 "Fatal: No wakeup from ca8210 after reset!\n"
693 dev_dbg(&spi->dev, "Reset the device\n");
697 * ca8210_mlme_reset_worker() - Resets the MLME, Called when the MAC OVERFLOW
699 * @work: Pointer to work being executed
701 static void ca8210_mlme_reset_worker(struct work_struct *work)
703 struct work_priv_container *wpc = container_of(
705 struct work_priv_container,
708 struct ca8210_priv *priv = wpc->priv;
710 mlme_reset_request_sync(0, priv->spi);
715 * ca8210_rx_done() - Calls various message dispatches responding to a received
717 * @arg: Pointer to the cas_control object for the relevant spi transfer
719 * Presents a received SAP command from the ca8210 to the Cascoda EVBME, test
720 * interface and network driver.
722 static void ca8210_rx_done(struct cas_control *cas_ctl)
726 struct work_priv_container *mlme_reset_wpc;
727 struct ca8210_priv *priv = cas_ctl->priv;
729 buf = cas_ctl->tx_in_buf;
731 if (len > CA8210_SPI_BUF_SIZE) {
734 "Received packet len (%u) erroneously long\n",
740 if (buf[0] & SPI_SYN) {
741 if (priv->sync_command_response) {
742 memcpy(priv->sync_command_response, buf, len);
743 complete(&priv->sync_exchange_complete);
745 if (cascoda_api_upstream)
746 cascoda_api_upstream(buf, len, priv->spi);
750 if (cascoda_api_upstream)
751 cascoda_api_upstream(buf, len, priv->spi);
754 ca8210_net_rx(priv->hw, buf, len);
755 if (buf[0] == SPI_MCPS_DATA_CONFIRM) {
756 if (buf[3] == MAC_TRANSACTION_OVERFLOW) {
759 "Waiting for transaction overflow to stabilise...\n");
763 "Resetting MAC...\n");
765 mlme_reset_wpc = kmalloc(sizeof(*mlme_reset_wpc),
770 &mlme_reset_wpc->work,
771 ca8210_mlme_reset_worker
773 mlme_reset_wpc->priv = priv;
774 queue_work(priv->mlme_workqueue, &mlme_reset_wpc->work);
776 } else if (buf[0] == SPI_HWME_WAKEUP_INDICATION) {
779 "Wakeup indication received, reason:\n"
785 "Transceiver woken up from Power Up / System Reset\n"
791 "Watchdog Timer Time-Out\n"
797 "Transceiver woken up from Power-Off by Sleep Timer Time-Out\n");
802 "Transceiver woken up from Power-Off by GPIO Activity\n"
808 "Transceiver woken up from Standby by Sleep Timer Time-Out\n"
814 "Transceiver woken up from Standby by GPIO Activity\n"
820 "Sleep-Timer Time-Out in Active Mode\n"
824 dev_warn(&priv->spi->dev, "Wakeup reason unknown\n");
827 complete(&priv->ca8210_is_awake);
833 static int ca8210_remove(struct spi_device *spi_device);
836 * ca8210_spi_transfer_complete() - Called when a single spi transfer has
838 * @context: Pointer to the cas_control object for the finished transfer
840 static void ca8210_spi_transfer_complete(void *context)
842 struct cas_control *cas_ctl = context;
843 struct ca8210_priv *priv = cas_ctl->priv;
844 bool duplex_rx = false;
846 u8 retry_buffer[CA8210_SPI_BUF_SIZE];
849 cas_ctl->tx_in_buf[0] == SPI_NACK ||
850 (cas_ctl->tx_in_buf[0] == SPI_IDLE &&
851 cas_ctl->tx_in_buf[1] == SPI_NACK)
854 dev_info(&priv->spi->dev, "ca8210 was busy during attempted write\n");
855 if (cas_ctl->tx_buf[0] == SPI_IDLE) {
858 "IRQ servicing NACKd, dropping transfer\n"
863 if (priv->retries > 3) {
864 dev_err(&priv->spi->dev, "too many retries!\n");
866 ca8210_remove(priv->spi);
869 memcpy(retry_buffer, cas_ctl->tx_buf, CA8210_SPI_BUF_SIZE);
877 dev_info(&priv->spi->dev, "retried spi write\n");
880 cas_ctl->tx_in_buf[0] != SPI_IDLE &&
881 cas_ctl->tx_in_buf[0] != SPI_NACK
887 dev_dbg(&priv->spi->dev, "READ CMD DURING TX\n");
888 for (i = 0; i < cas_ctl->tx_in_buf[1] + 2; i++)
892 cas_ctl->tx_in_buf[i]
894 ca8210_rx_done(cas_ctl);
896 complete(&priv->spi_transfer_complete);
902 * ca8210_spi_transfer() - Initiate duplex spi transfer with ca8210
903 * @spi: Pointer to spi device for transfer
904 * @buf: Octet array to send
905 * @len: length of the buffer being sent
907 * Return: 0 or linux error code
909 static int ca8210_spi_transfer(
910 struct spi_device *spi,
916 struct ca8210_priv *priv;
917 struct cas_control *cas_ctl;
920 pr_crit("NULL spi device passed to %s\n", __func__);
924 priv = spi_get_drvdata(spi);
925 reinit_completion(&priv->spi_transfer_complete);
927 dev_dbg(&spi->dev, "%s called\n", __func__);
929 cas_ctl = kmalloc(sizeof(*cas_ctl), GFP_ATOMIC);
933 cas_ctl->priv = priv;
934 memset(cas_ctl->tx_buf, SPI_IDLE, CA8210_SPI_BUF_SIZE);
935 memset(cas_ctl->tx_in_buf, SPI_IDLE, CA8210_SPI_BUF_SIZE);
936 memcpy(cas_ctl->tx_buf, buf, len);
938 for (i = 0; i < len; i++)
939 dev_dbg(&spi->dev, "%#03x\n", cas_ctl->tx_buf[i]);
941 spi_message_init(&cas_ctl->msg);
943 cas_ctl->transfer.tx_nbits = 1; /* 1 MOSI line */
944 cas_ctl->transfer.rx_nbits = 1; /* 1 MISO line */
945 cas_ctl->transfer.speed_hz = 0; /* Use device setting */
946 cas_ctl->transfer.bits_per_word = 0; /* Use device setting */
947 cas_ctl->transfer.tx_buf = cas_ctl->tx_buf;
948 cas_ctl->transfer.rx_buf = cas_ctl->tx_in_buf;
949 cas_ctl->transfer.delay.value = 0;
950 cas_ctl->transfer.delay.unit = SPI_DELAY_UNIT_USECS;
951 cas_ctl->transfer.cs_change = 0;
952 cas_ctl->transfer.len = sizeof(struct mac_message);
953 cas_ctl->msg.complete = ca8210_spi_transfer_complete;
954 cas_ctl->msg.context = cas_ctl;
956 spi_message_add_tail(
961 status = spi_async(spi, &cas_ctl->msg);
965 "status %d from spi_sync in write\n",
974 * ca8210_spi_exchange() - Exchange API/SAP commands with the radio
975 * @buf: Octet array of command being sent downstream
976 * @len: length of buf
977 * @response: buffer for storing synchronous response
978 * @device_ref: spi_device pointer for ca8210
980 * Effectively calls ca8210_spi_transfer to write buf[] to the spi, then for
981 * synchronous commands waits for the corresponding response to be read from
982 * the spi before returning. The response is written to the response parameter.
984 * Return: 0 or linux error code
986 static int ca8210_spi_exchange(
994 struct spi_device *spi = device_ref;
995 struct ca8210_priv *priv = spi->dev.driver_data;
998 if ((buf[0] & SPI_SYN) && response) { /* if sync wait for confirm */
999 reinit_completion(&priv->sync_exchange_complete);
1000 priv->sync_command_response = response;
1004 reinit_completion(&priv->spi_transfer_complete);
1005 status = ca8210_spi_transfer(priv->spi, buf, len);
1009 "spi write failed, returned %d\n",
1012 if (status == -EBUSY)
1014 if (((buf[0] & SPI_SYN) && response))
1015 complete(&priv->sync_exchange_complete);
1019 wait_remaining = wait_for_completion_interruptible_timeout(
1020 &priv->spi_transfer_complete,
1021 msecs_to_jiffies(1000)
1023 if (wait_remaining == -ERESTARTSYS) {
1024 status = -ERESTARTSYS;
1025 } else if (wait_remaining == 0) {
1028 "SPI downstream transfer timed out!\n"
1033 } while (status < 0);
1035 if (!((buf[0] & SPI_SYN) && response))
1038 wait_remaining = wait_for_completion_interruptible_timeout(
1039 &priv->sync_exchange_complete,
1040 msecs_to_jiffies(CA8210_SYNC_TIMEOUT)
1042 if (wait_remaining == -ERESTARTSYS) {
1043 status = -ERESTARTSYS;
1044 } else if (wait_remaining == 0) {
1047 "Synchronous confirm timeout\n"
1053 priv->sync_command_response = NULL;
1058 * ca8210_interrupt_handler() - Called when an irq is received from the ca8210
1059 * @irq: Id of the irq being handled
1060 * @dev_id: Pointer passed by the system, pointing to the ca8210's private data
1062 * This function is called when the irq line from the ca8210 is asserted,
1063 * signifying that the ca8210 has a message to send upstream to us. Starts the
1064 * asynchronous spi read.
1066 * Return: irq return code
1068 static irqreturn_t ca8210_interrupt_handler(int irq, void *dev_id)
1070 struct ca8210_priv *priv = dev_id;
1073 dev_dbg(&priv->spi->dev, "irq: Interrupt occurred\n");
1075 status = ca8210_spi_transfer(priv->spi, NULL, 0);
1076 if (status && (status != -EBUSY)) {
1079 "spi read failed, returned %d\n",
1083 } while (status == -EBUSY);
1087 static int (*cascoda_api_downstream)(
1092 ) = ca8210_spi_exchange;
1094 /* Cascoda API / 15.4 SAP Primitives */
1097 * tdme_setsfr_request_sync() - TDME_SETSFR_request/confirm according to API
1098 * @sfr_page: SFR Page
1099 * @sfr_address: SFR Address
1100 * @sfr_value: SFR Value
1101 * @device_ref: Nondescript pointer to target device
1103 * Return: 802.15.4 status code of TDME-SETSFR.confirm
1105 static u8 tdme_setsfr_request_sync(
1113 struct mac_message command, response;
1114 struct spi_device *spi = device_ref;
1116 command.command_id = SPI_TDME_SETSFR_REQUEST;
1118 command.pdata.tdme_set_sfr_req.sfr_page = sfr_page;
1119 command.pdata.tdme_set_sfr_req.sfr_address = sfr_address;
1120 command.pdata.tdme_set_sfr_req.sfr_value = sfr_value;
1121 response.command_id = SPI_IDLE;
1122 ret = cascoda_api_downstream(
1123 &command.command_id,
1125 &response.command_id,
1129 dev_crit(&spi->dev, "cascoda_api_downstream returned %d", ret);
1130 return MAC_SYSTEM_ERROR;
1133 if (response.command_id != SPI_TDME_SETSFR_CONFIRM) {
1136 "sync response to SPI_TDME_SETSFR_REQUEST was not SPI_TDME_SETSFR_CONFIRM, it was %d\n",
1139 return MAC_SYSTEM_ERROR;
1142 return response.pdata.tdme_set_sfr_cnf.status;
1146 * tdme_chipinit() - TDME Chip Register Default Initialisation Macro
1147 * @device_ref: Nondescript pointer to target device
1149 * Return: 802.15.4 status code of API calls
1151 static u8 tdme_chipinit(void *device_ref)
1153 u8 status = MAC_SUCCESS;
1155 struct spi_device *spi = device_ref;
1156 struct preamble_cfg_sfr pre_cfg_value = {
1157 .timeout_symbols = 3,
1158 .acquisition_symbols = 3,
1159 .search_symbols = 1,
1161 /* LNA Gain Settings */
1162 status = tdme_setsfr_request_sync(
1163 1, (sfr_address = CA8210_SFR_LNAGX40),
1164 LNAGX40_DEFAULT_GAIN, device_ref);
1167 status = tdme_setsfr_request_sync(
1168 1, (sfr_address = CA8210_SFR_LNAGX41),
1169 LNAGX41_DEFAULT_GAIN, device_ref);
1172 status = tdme_setsfr_request_sync(
1173 1, (sfr_address = CA8210_SFR_LNAGX42),
1174 LNAGX42_DEFAULT_GAIN, device_ref);
1177 status = tdme_setsfr_request_sync(
1178 1, (sfr_address = CA8210_SFR_LNAGX43),
1179 LNAGX43_DEFAULT_GAIN, device_ref);
1182 status = tdme_setsfr_request_sync(
1183 1, (sfr_address = CA8210_SFR_LNAGX44),
1184 LNAGX44_DEFAULT_GAIN, device_ref);
1187 status = tdme_setsfr_request_sync(
1188 1, (sfr_address = CA8210_SFR_LNAGX45),
1189 LNAGX45_DEFAULT_GAIN, device_ref);
1192 status = tdme_setsfr_request_sync(
1193 1, (sfr_address = CA8210_SFR_LNAGX46),
1194 LNAGX46_DEFAULT_GAIN, device_ref);
1197 status = tdme_setsfr_request_sync(
1198 1, (sfr_address = CA8210_SFR_LNAGX47),
1199 LNAGX47_DEFAULT_GAIN, device_ref);
1202 /* Preamble Timing Config */
1203 status = tdme_setsfr_request_sync(
1204 1, (sfr_address = CA8210_SFR_PRECFG),
1205 *((u8 *)&pre_cfg_value), device_ref);
1208 /* Preamble Threshold High */
1209 status = tdme_setsfr_request_sync(
1210 1, (sfr_address = CA8210_SFR_PTHRH),
1211 PTHRH_DEFAULT_THRESHOLD, device_ref);
1214 /* Tx Output Power 8 dBm */
1215 status = tdme_setsfr_request_sync(
1216 0, (sfr_address = CA8210_SFR_PACFGIB),
1217 PACFGIB_DEFAULT_CURRENT, device_ref);
1222 if (status != MAC_SUCCESS) {
1225 "failed to set sfr at %#03x, status = %#03x\n",
1234 * tdme_channelinit() - TDME Channel Register Default Initialisation Macro (Tx)
1235 * @channel: 802.15.4 channel to initialise chip for
1236 * @device_ref: Nondescript pointer to target device
1238 * Return: 802.15.4 status code of API calls
1240 static u8 tdme_channelinit(u8 channel, void *device_ref)
1242 /* Transceiver front-end local oscillator tx two-point calibration
1243 * value. Tuned for the hardware.
1249 else if (channel >= 23)
1251 else if (channel >= 22)
1253 else if (channel >= 20)
1255 else if (channel >= 17)
1257 else if (channel >= 16)
1259 else if (channel >= 14)
1261 else if (channel >= 12)
1266 return tdme_setsfr_request_sync(
1275 * tdme_checkpibattribute() - Checks Attribute Values that are not checked in
1277 * @pib_attribute: Attribute Number
1278 * @pib_attribute_length: Attribute length
1279 * @pib_attribute_value: Pointer to Attribute Value
1280 * @device_ref: Nondescript pointer to target device
1282 * Return: 802.15.4 status code of checks
1284 static u8 tdme_checkpibattribute(
1286 u8 pib_attribute_length,
1287 const void *pib_attribute_value
1290 u8 status = MAC_SUCCESS;
1293 value = *((u8 *)pib_attribute_value);
1295 switch (pib_attribute) {
1297 case PHY_TRANSMIT_POWER:
1299 status = MAC_INVALID_PARAMETER;
1303 status = MAC_INVALID_PARAMETER;
1306 case MAC_BATT_LIFE_EXT_PERIODS:
1307 if (value < 6 || value > 41)
1308 status = MAC_INVALID_PARAMETER;
1310 case MAC_BEACON_PAYLOAD:
1311 if (pib_attribute_length > MAX_BEACON_PAYLOAD_LENGTH)
1312 status = MAC_INVALID_PARAMETER;
1314 case MAC_BEACON_PAYLOAD_LENGTH:
1315 if (value > MAX_BEACON_PAYLOAD_LENGTH)
1316 status = MAC_INVALID_PARAMETER;
1318 case MAC_BEACON_ORDER:
1320 status = MAC_INVALID_PARAMETER;
1323 if (value < 3 || value > 8)
1324 status = MAC_INVALID_PARAMETER;
1326 case MAC_MAX_CSMA_BACKOFFS:
1328 status = MAC_INVALID_PARAMETER;
1330 case MAC_MAX_FRAME_RETRIES:
1332 status = MAC_INVALID_PARAMETER;
1336 status = MAC_INVALID_PARAMETER;
1338 case MAC_RESPONSE_WAIT_TIME:
1339 if (value < 2 || value > 64)
1340 status = MAC_INVALID_PARAMETER;
1342 case MAC_SUPERFRAME_ORDER:
1344 status = MAC_INVALID_PARAMETER;
1347 case MAC_ASSOCIATED_PAN_COORD:
1348 case MAC_ASSOCIATION_PERMIT:
1349 case MAC_AUTO_REQUEST:
1350 case MAC_BATT_LIFE_EXT:
1351 case MAC_GTS_PERMIT:
1352 case MAC_PROMISCUOUS_MODE:
1353 case MAC_RX_ON_WHEN_IDLE:
1354 case MAC_SECURITY_ENABLED:
1356 status = MAC_INVALID_PARAMETER;
1359 case MAC_AUTO_REQUEST_SECURITY_LEVEL:
1361 status = MAC_INVALID_PARAMETER;
1363 case MAC_AUTO_REQUEST_KEY_ID_MODE:
1365 status = MAC_INVALID_PARAMETER;
1375 * tdme_settxpower() - Sets the tx power for MLME_SET phyTransmitPower
1376 * @txp: Transmit Power
1377 * @device_ref: Nondescript pointer to target device
1379 * Normalised to 802.15.4 Definition (6-bit, signed):
1381 * Bit 5-0: tx power (-32 - +31 dB)
1383 * Return: 802.15.4 status code of api calls
1385 static u8 tdme_settxpower(u8 txp, void *device_ref)
1390 union pa_cfg_sfr pa_cfg_val;
1392 /* extend from 6 to 8 bit */
1393 txp_ext = 0x3F & txp;
1396 txp_val = (s8)txp_ext;
1398 if (CA8210_MAC_MPW) {
1400 /* 8 dBm: ptrim = 5, itrim = +3 => +4 dBm */
1401 pa_cfg_val.bias_current_trim = 3;
1402 pa_cfg_val.buffer_capacitor_trim = 5;
1403 pa_cfg_val.boost = 1;
1405 /* 0 dBm: ptrim = 7, itrim = +3 => -6 dBm */
1406 pa_cfg_val.bias_current_trim = 3;
1407 pa_cfg_val.buffer_capacitor_trim = 7;
1408 pa_cfg_val.boost = 0;
1411 status = tdme_setsfr_request_sync(
1418 /* Look-Up Table for Setting Current and Frequency Trim values
1419 * for desired Output Power
1422 pa_cfg_val.paib = 0x3F;
1423 } else if (txp_val == 8) {
1424 pa_cfg_val.paib = 0x32;
1425 } else if (txp_val == 7) {
1426 pa_cfg_val.paib = 0x22;
1427 } else if (txp_val == 6) {
1428 pa_cfg_val.paib = 0x18;
1429 } else if (txp_val == 5) {
1430 pa_cfg_val.paib = 0x10;
1431 } else if (txp_val == 4) {
1432 pa_cfg_val.paib = 0x0C;
1433 } else if (txp_val == 3) {
1434 pa_cfg_val.paib = 0x08;
1435 } else if (txp_val == 2) {
1436 pa_cfg_val.paib = 0x05;
1437 } else if (txp_val == 1) {
1438 pa_cfg_val.paib = 0x03;
1439 } else if (txp_val == 0) {
1440 pa_cfg_val.paib = 0x01;
1442 pa_cfg_val.paib = 0x00;
1445 status = tdme_setsfr_request_sync(
1457 * mcps_data_request() - mcps_data_request (Send Data) according to API Spec
1458 * @src_addr_mode: Source Addressing Mode
1459 * @dst_address_mode: Destination Addressing Mode
1460 * @dst_pan_id: Destination PAN ID
1461 * @dst_addr: Pointer to Destination Address
1462 * @msdu_length: length of Data
1463 * @msdu: Pointer to Data
1464 * @msdu_handle: Handle of Data
1465 * @tx_options: Tx Options Bit Field
1466 * @security: Pointer to Security Structure or NULL
1467 * @device_ref: Nondescript pointer to target device
1469 * Return: 802.15.4 status code of action
1471 static u8 mcps_data_request(
1473 u8 dst_address_mode,
1475 union macaddr *dst_addr,
1480 struct secspec *security,
1484 struct secspec *psec;
1485 struct mac_message command;
1487 command.command_id = SPI_MCPS_DATA_REQUEST;
1488 command.pdata.data_req.src_addr_mode = src_addr_mode;
1489 command.pdata.data_req.dst.mode = dst_address_mode;
1490 if (dst_address_mode != MAC_MODE_NO_ADDR) {
1491 command.pdata.data_req.dst.pan_id[0] = LS_BYTE(dst_pan_id);
1492 command.pdata.data_req.dst.pan_id[1] = MS_BYTE(dst_pan_id);
1493 if (dst_address_mode == MAC_MODE_SHORT_ADDR) {
1494 command.pdata.data_req.dst.address[0] = LS_BYTE(
1495 dst_addr->short_address
1497 command.pdata.data_req.dst.address[1] = MS_BYTE(
1498 dst_addr->short_address
1500 } else { /* MAC_MODE_LONG_ADDR*/
1502 command.pdata.data_req.dst.address,
1503 dst_addr->ieee_address,
1508 command.pdata.data_req.msdu_length = msdu_length;
1509 command.pdata.data_req.msdu_handle = msdu_handle;
1510 command.pdata.data_req.tx_options = tx_options;
1511 memcpy(command.pdata.data_req.msdu, msdu, msdu_length);
1512 psec = (struct secspec *)(command.pdata.data_req.msdu + msdu_length);
1513 command.length = sizeof(struct mcps_data_request_pset) -
1514 MAX_DATA_SIZE + msdu_length;
1515 if (!security || security->security_level == 0) {
1516 psec->security_level = 0;
1517 command.length += 1;
1520 command.length += sizeof(struct secspec);
1523 if (ca8210_spi_transfer(device_ref, &command.command_id,
1524 command.length + 2))
1525 return MAC_SYSTEM_ERROR;
1531 * mlme_reset_request_sync() - MLME_RESET_request/confirm according to API Spec
1532 * @set_default_pib: Set defaults in PIB
1533 * @device_ref: Nondescript pointer to target device
1535 * Return: 802.15.4 status code of MLME-RESET.confirm
1537 static u8 mlme_reset_request_sync(
1543 struct mac_message command, response;
1544 struct spi_device *spi = device_ref;
1546 command.command_id = SPI_MLME_RESET_REQUEST;
1548 command.pdata.u8param = set_default_pib;
1550 if (cascoda_api_downstream(
1551 &command.command_id,
1553 &response.command_id,
1555 dev_err(&spi->dev, "cascoda_api_downstream failed\n");
1556 return MAC_SYSTEM_ERROR;
1559 if (response.command_id != SPI_MLME_RESET_CONFIRM)
1560 return MAC_SYSTEM_ERROR;
1562 status = response.pdata.status;
1564 /* reset COORD Bit for Channel Filtering as Coordinator */
1565 if (CA8210_MAC_WORKAROUNDS && set_default_pib && !status) {
1566 status = tdme_setsfr_request_sync(
1578 * mlme_set_request_sync() - MLME_SET_request/confirm according to API Spec
1579 * @pib_attribute: Attribute Number
1580 * @pib_attribute_index: Index within Attribute if an Array
1581 * @pib_attribute_length: Attribute length
1582 * @pib_attribute_value: Pointer to Attribute Value
1583 * @device_ref: Nondescript pointer to target device
1585 * Return: 802.15.4 status code of MLME-SET.confirm
1587 static u8 mlme_set_request_sync(
1589 u8 pib_attribute_index,
1590 u8 pib_attribute_length,
1591 const void *pib_attribute_value,
1596 struct mac_message command, response;
1598 /* pre-check the validity of pib_attribute values that are not checked
1601 if (tdme_checkpibattribute(
1602 pib_attribute, pib_attribute_length, pib_attribute_value)) {
1603 return MAC_INVALID_PARAMETER;
1606 if (pib_attribute == PHY_CURRENT_CHANNEL) {
1607 status = tdme_channelinit(
1608 *((u8 *)pib_attribute_value),
1615 if (pib_attribute == PHY_TRANSMIT_POWER) {
1616 return tdme_settxpower(
1617 *((u8 *)pib_attribute_value),
1622 command.command_id = SPI_MLME_SET_REQUEST;
1623 command.length = sizeof(struct mlme_set_request_pset) -
1624 MAX_ATTRIBUTE_SIZE + pib_attribute_length;
1625 command.pdata.set_req.pib_attribute = pib_attribute;
1626 command.pdata.set_req.pib_attribute_index = pib_attribute_index;
1627 command.pdata.set_req.pib_attribute_length = pib_attribute_length;
1629 command.pdata.set_req.pib_attribute_value,
1630 pib_attribute_value,
1631 pib_attribute_length
1634 if (cascoda_api_downstream(
1635 &command.command_id,
1637 &response.command_id,
1639 return MAC_SYSTEM_ERROR;
1642 if (response.command_id != SPI_MLME_SET_CONFIRM)
1643 return MAC_SYSTEM_ERROR;
1645 return response.pdata.status;
1649 * hwme_set_request_sync() - HWME_SET_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-SET.confirm
1657 static u8 hwme_set_request_sync(
1659 u8 hw_attribute_length,
1660 u8 *hw_attribute_value,
1664 struct mac_message command, response;
1666 command.command_id = SPI_HWME_SET_REQUEST;
1667 command.length = 2 + hw_attribute_length;
1668 command.pdata.hwme_set_req.hw_attribute = hw_attribute;
1669 command.pdata.hwme_set_req.hw_attribute_length = hw_attribute_length;
1671 command.pdata.hwme_set_req.hw_attribute_value,
1676 if (cascoda_api_downstream(
1677 &command.command_id,
1679 &response.command_id,
1681 return MAC_SYSTEM_ERROR;
1684 if (response.command_id != SPI_HWME_SET_CONFIRM)
1685 return MAC_SYSTEM_ERROR;
1687 return response.pdata.hwme_set_cnf.status;
1691 * hwme_get_request_sync() - HWME_GET_request/confirm according to API Spec
1692 * @hw_attribute: Attribute Number
1693 * @hw_attribute_length: Attribute length
1694 * @hw_attribute_value: Pointer to Attribute Value
1695 * @device_ref: Nondescript pointer to target device
1697 * Return: 802.15.4 status code of HWME-GET.confirm
1699 static u8 hwme_get_request_sync(
1701 u8 *hw_attribute_length,
1702 u8 *hw_attribute_value,
1706 struct mac_message command, response;
1708 command.command_id = SPI_HWME_GET_REQUEST;
1710 command.pdata.hwme_get_req.hw_attribute = hw_attribute;
1712 if (cascoda_api_downstream(
1713 &command.command_id,
1715 &response.command_id,
1717 return MAC_SYSTEM_ERROR;
1720 if (response.command_id != SPI_HWME_GET_CONFIRM)
1721 return MAC_SYSTEM_ERROR;
1723 if (response.pdata.hwme_get_cnf.status == MAC_SUCCESS) {
1724 *hw_attribute_length =
1725 response.pdata.hwme_get_cnf.hw_attribute_length;
1728 response.pdata.hwme_get_cnf.hw_attribute_value,
1729 *hw_attribute_length
1733 return response.pdata.hwme_get_cnf.status;
1736 /* Network driver operation */
1739 * ca8210_async_xmit_complete() - Called to announce that an asynchronous
1740 * transmission has finished
1741 * @hw: ieee802154_hw of ca8210 that has finished exchange
1742 * @msduhandle: Identifier of transmission that has completed
1743 * @status: Returned 802.15.4 status code of the transmission
1745 * Return: 0 or linux error code
1747 static int ca8210_async_xmit_complete(
1748 struct ieee802154_hw *hw,
1752 struct ca8210_priv *priv = hw->priv;
1754 if (priv->nextmsduhandle != msduhandle) {
1757 "Unexpected msdu_handle on data confirm, Expected %d, got %d\n",
1758 priv->nextmsduhandle,
1764 priv->async_tx_pending = false;
1765 priv->nextmsduhandle++;
1770 "Link transmission unsuccessful, status = %d\n",
1773 if (status != MAC_TRANSACTION_OVERFLOW) {
1774 dev_kfree_skb_any(priv->tx_skb);
1775 ieee802154_wake_queue(priv->hw);
1779 ieee802154_xmit_complete(priv->hw, priv->tx_skb, true);
1785 * ca8210_skb_rx() - Contructs a properly framed socket buffer from a received
1786 * MCPS_DATA_indication
1787 * @hw: ieee802154_hw that MCPS_DATA_indication was received by
1788 * @len: length of MCPS_DATA_indication
1789 * @data_ind: Octet array of MCPS_DATA_indication
1791 * Called by the spi driver whenever a SAP command is received, this function
1792 * will ascertain whether the command is of interest to the network driver and
1793 * take necessary action.
1795 * Return: 0 or linux error code
1797 static int ca8210_skb_rx(
1798 struct ieee802154_hw *hw,
1803 struct ieee802154_hdr hdr;
1806 u8 mpdulinkquality = data_ind[23];
1807 struct sk_buff *skb;
1808 struct ca8210_priv *priv = hw->priv;
1810 /* Allocate mtu size buffer for every rx packet */
1811 skb = dev_alloc_skb(IEEE802154_MTU + sizeof(hdr));
1815 skb_reserve(skb, sizeof(hdr));
1817 msdulen = data_ind[22]; /* msdu_length */
1818 if (msdulen > IEEE802154_MTU) {
1821 "received erroneously large msdu length!\n"
1826 dev_dbg(&priv->spi->dev, "skb buffer length = %d\n", msdulen);
1828 if (priv->promiscuous)
1832 hdr.sec.level = data_ind[29 + msdulen];
1833 dev_dbg(&priv->spi->dev, "security level: %#03x\n", hdr.sec.level);
1834 if (hdr.sec.level > 0) {
1835 hdr.sec.key_id_mode = data_ind[30 + msdulen];
1836 memcpy(&hdr.sec.extended_src, &data_ind[31 + msdulen], 8);
1837 hdr.sec.key_id = data_ind[39 + msdulen];
1839 hdr.source.mode = data_ind[0];
1840 dev_dbg(&priv->spi->dev, "srcAddrMode: %#03x\n", hdr.source.mode);
1841 hdr.source.pan_id = *(u16 *)&data_ind[1];
1842 dev_dbg(&priv->spi->dev, "srcPanId: %#06x\n", hdr.source.pan_id);
1843 memcpy(&hdr.source.extended_addr, &data_ind[3], 8);
1844 hdr.dest.mode = data_ind[11];
1845 dev_dbg(&priv->spi->dev, "dstAddrMode: %#03x\n", hdr.dest.mode);
1846 hdr.dest.pan_id = *(u16 *)&data_ind[12];
1847 dev_dbg(&priv->spi->dev, "dstPanId: %#06x\n", hdr.dest.pan_id);
1848 memcpy(&hdr.dest.extended_addr, &data_ind[14], 8);
1850 /* Fill in FC implicitly */
1851 hdr.fc.type = 1; /* Data frame */
1853 hdr.fc.security_enabled = 1;
1855 hdr.fc.security_enabled = 0;
1856 if (data_ind[1] != data_ind[12] || data_ind[2] != data_ind[13])
1857 hdr.fc.intra_pan = 1;
1859 hdr.fc.intra_pan = 0;
1860 hdr.fc.dest_addr_mode = hdr.dest.mode;
1861 hdr.fc.source_addr_mode = hdr.source.mode;
1863 /* Add hdr to front of buffer */
1864 hlen = ieee802154_hdr_push(skb, &hdr);
1867 dev_crit(&priv->spi->dev, "failed to push mac hdr onto skb!\n");
1872 skb_reset_mac_header(skb);
1873 skb->mac_len = hlen;
1876 /* Add <msdulen> bytes of space to the back of the buffer */
1877 /* Copy msdu to skb */
1878 skb_put_data(skb, &data_ind[29], msdulen);
1880 ieee802154_rx_irqsafe(hw, skb, mpdulinkquality);
1885 * ca8210_net_rx() - Acts upon received SAP commands relevant to the network
1887 * @hw: ieee802154_hw that command was received by
1888 * @command: Octet array of received command
1889 * @len: length of the received command
1891 * Called by the spi driver whenever a SAP command is received, this function
1892 * will ascertain whether the command is of interest to the network driver and
1893 * take necessary action.
1895 * Return: 0 or linux error code
1897 static int ca8210_net_rx(struct ieee802154_hw *hw, u8 *command, size_t len)
1899 struct ca8210_priv *priv = hw->priv;
1900 unsigned long flags;
1903 dev_dbg(&priv->spi->dev, "%s: CmdID = %d\n", __func__, command[0]);
1905 if (command[0] == SPI_MCPS_DATA_INDICATION) {
1907 spin_lock_irqsave(&priv->lock, flags);
1908 if (command[26] == priv->last_dsn) {
1911 "DSN %d resend received, ignoring...\n",
1914 spin_unlock_irqrestore(&priv->lock, flags);
1917 priv->last_dsn = command[26];
1918 spin_unlock_irqrestore(&priv->lock, flags);
1919 return ca8210_skb_rx(hw, len - 2, command + 2);
1920 } else if (command[0] == SPI_MCPS_DATA_CONFIRM) {
1921 status = command[3];
1922 if (priv->async_tx_pending) {
1923 return ca8210_async_xmit_complete(
1935 * ca8210_skb_tx() - Transmits a given socket buffer using the ca8210
1936 * @skb: Socket buffer to transmit
1937 * @msduhandle: Data identifier to pass to the 802.15.4 MAC
1938 * @priv: Pointer to private data section of target ca8210
1940 * Return: 0 or linux error code
1942 static int ca8210_skb_tx(
1943 struct sk_buff *skb,
1945 struct ca8210_priv *priv
1949 struct ieee802154_hdr header = { };
1950 struct secspec secspec;
1951 unsigned int mac_len;
1953 dev_dbg(&priv->spi->dev, "%s called\n", __func__);
1955 /* Get addressing info from skb - ieee802154 layer creates a full
1958 mac_len = ieee802154_hdr_peek_addrs(skb, &header);
1960 secspec.security_level = header.sec.level;
1961 secspec.key_id_mode = header.sec.key_id_mode;
1962 if (secspec.key_id_mode == 2)
1963 memcpy(secspec.key_source, &header.sec.short_src, 4);
1964 else if (secspec.key_id_mode == 3)
1965 memcpy(secspec.key_source, &header.sec.extended_src, 8);
1966 secspec.key_index = header.sec.key_id;
1968 /* Pass to Cascoda API */
1969 status = mcps_data_request(
1973 (union macaddr *)&header.dest.extended_addr,
1975 &skb->data[mac_len],
1977 header.fc.ack_request,
1981 return link_to_linux_err(status);
1985 * ca8210_start() - Starts the network driver
1986 * @hw: ieee802154_hw of ca8210 being started
1988 * Return: 0 or linux error code
1990 static int ca8210_start(struct ieee802154_hw *hw)
1994 u8 lqi_threshold = 0;
1995 struct ca8210_priv *priv = hw->priv;
1997 priv->last_dsn = -1;
1998 /* Turn receiver on when idle for now just to test rx */
1999 rx_on_when_idle = 1;
2000 status = mlme_set_request_sync(
2001 MAC_RX_ON_WHEN_IDLE,
2010 "Setting rx_on_when_idle failed, status = %d\n",
2013 return link_to_linux_err(status);
2015 status = hwme_set_request_sync(
2024 "Setting lqilimit failed, status = %d\n",
2027 return link_to_linux_err(status);
2034 * ca8210_stop() - Stops the network driver
2035 * @hw: ieee802154_hw of ca8210 being stopped
2037 * Return: 0 or linux error code
2039 static void ca8210_stop(struct ieee802154_hw *hw)
2044 * ca8210_xmit_async() - Asynchronously transmits a given socket buffer using
2046 * @hw: ieee802154_hw of ca8210 to transmit from
2047 * @skb: Socket buffer to transmit
2049 * Return: 0 or linux error code
2051 static int ca8210_xmit_async(struct ieee802154_hw *hw, struct sk_buff *skb)
2053 struct ca8210_priv *priv = hw->priv;
2056 dev_dbg(&priv->spi->dev, "calling %s\n", __func__);
2059 priv->async_tx_pending = true;
2060 status = ca8210_skb_tx(skb, priv->nextmsduhandle, priv);
2065 * ca8210_get_ed() - Returns the measured energy on the current channel at this
2067 * @hw: ieee802154_hw of target ca8210
2068 * @level: Measured Energy Detect level
2070 * Return: 0 or linux error code
2072 static int ca8210_get_ed(struct ieee802154_hw *hw, u8 *level)
2075 struct ca8210_priv *priv = hw->priv;
2077 return link_to_linux_err(
2078 hwme_get_request_sync(HWME_EDVALUE, &lenvar, level, priv->spi)
2083 * ca8210_set_channel() - Sets the current operating 802.15.4 channel of the
2085 * @hw: ieee802154_hw of target ca8210
2086 * @page: Channel page to set
2087 * @channel: Channel number to set
2089 * Return: 0 or linux error code
2091 static int ca8210_set_channel(
2092 struct ieee802154_hw *hw,
2098 struct ca8210_priv *priv = hw->priv;
2100 status = mlme_set_request_sync(
2101 PHY_CURRENT_CHANNEL,
2110 "error setting channel, MLME-SET.confirm status = %d\n",
2114 return link_to_linux_err(status);
2118 * ca8210_set_hw_addr_filt() - Sets the address filtering parameters of the
2120 * @hw: ieee802154_hw of target ca8210
2121 * @filt: Filtering parameters
2122 * @changed: Bitmap representing which parameters to change
2124 * Effectively just sets the actual addressing information identifying this node
2125 * as all filtering is performed by the ca8210 as detailed in the IEEE 802.15.4
2126 * 2006 specification.
2128 * Return: 0 or linux error code
2130 static int ca8210_set_hw_addr_filt(
2131 struct ieee802154_hw *hw,
2132 struct ieee802154_hw_addr_filt *filt,
2133 unsigned long changed
2137 struct ca8210_priv *priv = hw->priv;
2139 if (changed & IEEE802154_AFILT_PANID_CHANGED) {
2140 status = mlme_set_request_sync(
2144 &filt->pan_id, priv->spi
2149 "error setting pan id, MLME-SET.confirm status = %d",
2152 return link_to_linux_err(status);
2155 if (changed & IEEE802154_AFILT_SADDR_CHANGED) {
2156 status = mlme_set_request_sync(
2160 &filt->short_addr, priv->spi
2165 "error setting short address, MLME-SET.confirm status = %d",
2168 return link_to_linux_err(status);
2171 if (changed & IEEE802154_AFILT_IEEEADDR_CHANGED) {
2172 status = mlme_set_request_sync(
2182 "error setting ieee address, MLME-SET.confirm status = %d",
2185 return link_to_linux_err(status);
2188 /* TODO: Should use MLME_START to set coord bit? */
2193 * ca8210_set_tx_power() - Sets the transmit power of the ca8210
2194 * @hw: ieee802154_hw of target ca8210
2195 * @mbm: Transmit power in mBm (dBm*100)
2197 * Return: 0 or linux error code
2199 static int ca8210_set_tx_power(struct ieee802154_hw *hw, s32 mbm)
2201 struct ca8210_priv *priv = hw->priv;
2204 return link_to_linux_err(
2205 mlme_set_request_sync(PHY_TRANSMIT_POWER, 0, 1, &mbm, priv->spi)
2210 * ca8210_set_cca_mode() - Sets the clear channel assessment mode of the ca8210
2211 * @hw: ieee802154_hw of target ca8210
2212 * @cca: CCA mode to set
2214 * Return: 0 or linux error code
2216 static int ca8210_set_cca_mode(
2217 struct ieee802154_hw *hw,
2218 const struct wpan_phy_cca *cca
2223 struct ca8210_priv *priv = hw->priv;
2225 cca_mode = cca->mode & 3;
2226 if (cca_mode == 3 && cca->opt == NL802154_CCA_OPT_ENERGY_CARRIER_OR) {
2227 /* cca_mode 0 == CS OR ED, 3 == CS AND ED */
2230 status = mlme_set_request_sync(
2240 "error setting cca mode, MLME-SET.confirm status = %d",
2244 return link_to_linux_err(status);
2248 * ca8210_set_cca_ed_level() - Sets the CCA ED level of the ca8210
2249 * @hw: ieee802154_hw of target ca8210
2250 * @level: ED level to set (in mbm)
2252 * Sets the minimum threshold of measured energy above which the ca8210 will
2253 * back off and retry a transmission.
2255 * Return: 0 or linux error code
2257 static int ca8210_set_cca_ed_level(struct ieee802154_hw *hw, s32 level)
2260 u8 ed_threshold = (level / 100) * 2 + 256;
2261 struct ca8210_priv *priv = hw->priv;
2263 status = hwme_set_request_sync(
2272 "error setting ed threshold, HWME-SET.confirm status = %d",
2276 return link_to_linux_err(status);
2280 * ca8210_set_csma_params() - Sets the CSMA parameters of the ca8210
2281 * @hw: ieee802154_hw of target ca8210
2282 * @min_be: Minimum backoff exponent when backing off a transmission
2283 * @max_be: Maximum backoff exponent when backing off a transmission
2284 * @retries: Number of times to retry after backing off
2286 * Return: 0 or linux error code
2288 static int ca8210_set_csma_params(
2289 struct ieee802154_hw *hw,
2296 struct ca8210_priv *priv = hw->priv;
2298 status = mlme_set_request_sync(MAC_MIN_BE, 0, 1, &min_be, priv->spi);
2302 "error setting min be, MLME-SET.confirm status = %d",
2305 return link_to_linux_err(status);
2307 status = mlme_set_request_sync(MAC_MAX_BE, 0, 1, &max_be, priv->spi);
2311 "error setting max be, MLME-SET.confirm status = %d",
2314 return link_to_linux_err(status);
2316 status = mlme_set_request_sync(
2317 MAC_MAX_CSMA_BACKOFFS,
2326 "error setting max csma backoffs, MLME-SET.confirm status = %d",
2330 return link_to_linux_err(status);
2334 * ca8210_set_frame_retries() - Sets the maximum frame retries of the ca8210
2335 * @hw: ieee802154_hw of target ca8210
2336 * @retries: Number of retries
2338 * Sets the number of times to retry a transmission if no acknowledgment was
2339 * was received from the other end when one was requested.
2341 * Return: 0 or linux error code
2343 static int ca8210_set_frame_retries(struct ieee802154_hw *hw, s8 retries)
2346 struct ca8210_priv *priv = hw->priv;
2348 status = mlme_set_request_sync(
2349 MAC_MAX_FRAME_RETRIES,
2358 "error setting frame retries, MLME-SET.confirm status = %d",
2362 return link_to_linux_err(status);
2365 static int ca8210_set_promiscuous_mode(struct ieee802154_hw *hw, const bool on)
2368 struct ca8210_priv *priv = hw->priv;
2370 status = mlme_set_request_sync(
2371 MAC_PROMISCUOUS_MODE,
2380 "error setting promiscuous mode, MLME-SET.confirm status = %d",
2384 priv->promiscuous = on;
2386 return link_to_linux_err(status);
2389 static const struct ieee802154_ops ca8210_phy_ops = {
2390 .start = ca8210_start,
2391 .stop = ca8210_stop,
2392 .xmit_async = ca8210_xmit_async,
2393 .ed = ca8210_get_ed,
2394 .set_channel = ca8210_set_channel,
2395 .set_hw_addr_filt = ca8210_set_hw_addr_filt,
2396 .set_txpower = ca8210_set_tx_power,
2397 .set_cca_mode = ca8210_set_cca_mode,
2398 .set_cca_ed_level = ca8210_set_cca_ed_level,
2399 .set_csma_params = ca8210_set_csma_params,
2400 .set_frame_retries = ca8210_set_frame_retries,
2401 .set_promiscuous_mode = ca8210_set_promiscuous_mode
2404 /* Test/EVBME Interface */
2407 * ca8210_test_int_open() - Opens the test interface to the userspace
2408 * @inodp: inode representation of file interface
2409 * @filp: file interface
2411 * Return: 0 or linux error code
2413 static int ca8210_test_int_open(struct inode *inodp, struct file *filp)
2415 struct ca8210_priv *priv = inodp->i_private;
2417 filp->private_data = priv;
2422 * ca8210_test_check_upstream() - Checks a command received from the upstream
2423 * testing interface for required action
2424 * @buf: Buffer containing command to check
2425 * @device_ref: Nondescript pointer to target device
2427 * Return: 0 or linux error code
2429 static int ca8210_test_check_upstream(u8 *buf, void *device_ref)
2432 u8 response[CA8210_SPI_BUF_SIZE];
2434 if (buf[0] == SPI_MLME_SET_REQUEST) {
2435 ret = tdme_checkpibattribute(buf[2], buf[4], buf + 5);
2437 response[0] = SPI_MLME_SET_CONFIRM;
2439 response[2] = MAC_INVALID_PARAMETER;
2440 response[3] = buf[2];
2441 response[4] = buf[3];
2442 if (cascoda_api_upstream)
2443 cascoda_api_upstream(response, 5, device_ref);
2447 if (buf[0] == SPI_MLME_ASSOCIATE_REQUEST) {
2448 return tdme_channelinit(buf[2], device_ref);
2449 } else if (buf[0] == SPI_MLME_START_REQUEST) {
2450 return tdme_channelinit(buf[4], device_ref);
2452 (buf[0] == SPI_MLME_SET_REQUEST) &&
2453 (buf[2] == PHY_CURRENT_CHANNEL)
2455 return tdme_channelinit(buf[5], device_ref);
2457 (buf[0] == SPI_TDME_SET_REQUEST) &&
2458 (buf[2] == TDME_CHANNEL)
2460 return tdme_channelinit(buf[4], device_ref);
2462 (CA8210_MAC_WORKAROUNDS) &&
2463 (buf[0] == SPI_MLME_RESET_REQUEST) &&
2466 /* reset COORD Bit for Channel Filtering as Coordinator */
2467 return tdme_setsfr_request_sync(
2475 } /* End of EVBMECheckSerialCommand() */
2478 * ca8210_test_int_user_write() - Called by a process in userspace to send a
2479 * message to the ca8210 drivers
2480 * @filp: file interface
2481 * @in_buf: Buffer containing message to write
2482 * @len: length of message
2485 * Return: 0 or linux error code
2487 static ssize_t ca8210_test_int_user_write(
2489 const char __user *in_buf,
2495 struct ca8210_priv *priv = filp->private_data;
2496 u8 command[CA8210_SPI_BUF_SIZE];
2498 memset(command, SPI_IDLE, 6);
2499 if (len > CA8210_SPI_BUF_SIZE || len < 2) {
2502 "userspace requested erroneous write length (%zu)\n",
2508 ret = copy_from_user(command, in_buf, len);
2512 "%d bytes could not be copied from userspace\n",
2517 if (len != command[1] + 2) {
2520 "write len does not match packet length field\n"
2525 ret = ca8210_test_check_upstream(command, priv->spi);
2527 ret = ca8210_spi_exchange(
2534 /* effectively 0 bytes were written successfully */
2537 "spi exchange failed\n"
2541 if (command[0] & SPI_SYN)
2549 * ca8210_test_int_user_read() - Called by a process in userspace to read a
2550 * message from the ca8210 drivers
2551 * @filp: file interface
2552 * @buf: Buffer to write message to
2553 * @len: length of message to read (ignored)
2554 * @offp: file offset
2556 * If the O_NONBLOCK flag was set when opening the file then this function will
2557 * not block, i.e. it will return if the fifo is empty. Otherwise the function
2558 * will block, i.e. wait until new data arrives.
2560 * Return: number of bytes read
2562 static ssize_t ca8210_test_int_user_read(
2570 struct ca8210_priv *priv = filp->private_data;
2571 unsigned char *fifo_buffer;
2572 unsigned long bytes_not_copied;
2574 if (filp->f_flags & O_NONBLOCK) {
2575 /* Non-blocking mode */
2576 if (kfifo_is_empty(&priv->test.up_fifo))
2580 wait_event_interruptible(
2582 !kfifo_is_empty(&priv->test.up_fifo)
2586 if (kfifo_out(&priv->test.up_fifo, &fifo_buffer, 4) != 4) {
2589 "test_interface: Wrong number of elements popped from upstream fifo\n"
2593 cmdlen = fifo_buffer[1];
2594 bytes_not_copied = cmdlen + 2;
2596 bytes_not_copied = copy_to_user(buf, fifo_buffer, bytes_not_copied);
2597 if (bytes_not_copied > 0) {
2600 "%lu bytes could not be copied to user space!\n",
2605 dev_dbg(&priv->spi->dev, "test_interface: Cmd len = %d\n", cmdlen);
2607 dev_dbg(&priv->spi->dev, "test_interface: Read\n");
2608 for (i = 0; i < cmdlen + 2; i++)
2609 dev_dbg(&priv->spi->dev, "%#03x\n", fifo_buffer[i]);
2617 * ca8210_test_int_ioctl() - Called by a process in userspace to enact an
2619 * @filp: file interface
2620 * @ioctl_num: which action to enact
2621 * @ioctl_param: arbitrary parameter for the action
2625 static long ca8210_test_int_ioctl(
2627 unsigned int ioctl_num,
2628 unsigned long ioctl_param
2631 struct ca8210_priv *priv = filp->private_data;
2633 switch (ioctl_num) {
2634 case CA8210_IOCTL_HARD_RESET:
2635 ca8210_reset_send(priv->spi, ioctl_param);
2644 * ca8210_test_int_poll() - Called by a process in userspace to determine which
2645 * actions are currently possible for the file
2646 * @filp: file interface
2647 * @ptable: poll table
2649 * Return: set of poll return flags
2651 static __poll_t ca8210_test_int_poll(
2653 struct poll_table_struct *ptable
2656 __poll_t return_flags = 0;
2657 struct ca8210_priv *priv = filp->private_data;
2659 poll_wait(filp, &priv->test.readq, ptable);
2660 if (!kfifo_is_empty(&priv->test.up_fifo))
2661 return_flags |= (EPOLLIN | EPOLLRDNORM);
2662 if (wait_event_interruptible(
2664 !kfifo_is_empty(&priv->test.up_fifo))) {
2667 return return_flags;
2670 static const struct file_operations test_int_fops = {
2671 .read = ca8210_test_int_user_read,
2672 .write = ca8210_test_int_user_write,
2673 .open = ca8210_test_int_open,
2675 .unlocked_ioctl = ca8210_test_int_ioctl,
2676 .poll = ca8210_test_int_poll
2682 * ca8210_get_platform_data() - Populate a ca8210_platform_data object
2683 * @spi_device: Pointer to ca8210 spi device object to get data for
2684 * @pdata: Pointer to ca8210_platform_data object to populate
2686 * Return: 0 or linux error code
2688 static int ca8210_get_platform_data(
2689 struct spi_device *spi_device,
2690 struct ca8210_platform_data *pdata
2695 if (!spi_device->dev.of_node)
2698 pdata->extclockenable = of_property_read_bool(
2699 spi_device->dev.of_node,
2702 if (pdata->extclockenable) {
2703 ret = of_property_read_u32(
2704 spi_device->dev.of_node,
2706 &pdata->extclockfreq
2711 ret = of_property_read_u32(
2712 spi_device->dev.of_node,
2714 &pdata->extclockgpio
2722 * ca8210_config_extern_clk() - Configure the external clock provided by the
2724 * @pdata: Pointer to ca8210_platform_data containing clock parameters
2725 * @spi: Pointer to target ca8210 spi device
2726 * @on: True to turn the clock on, false to turn off
2728 * The external clock is configured with a frequency and output pin taken from
2729 * the platform data.
2731 * Return: 0 or linux error code
2733 static int ca8210_config_extern_clk(
2734 struct ca8210_platform_data *pdata,
2735 struct spi_device *spi,
2742 dev_info(&spi->dev, "Switching external clock on\n");
2743 switch (pdata->extclockfreq) {
2760 dev_crit(&spi->dev, "Invalid extclock-freq\n");
2763 clkparam[1] = pdata->extclockgpio;
2765 dev_info(&spi->dev, "Switching external clock off\n");
2766 clkparam[0] = 0; /* off */
2769 return link_to_linux_err(
2770 hwme_set_request_sync(HWME_SYSCLKOUT, 2, clkparam, spi)
2775 * ca8210_register_ext_clock() - Register ca8210's external clock with kernel
2776 * @spi: Pointer to target ca8210 spi device
2778 * Return: 0 or linux error code
2780 static int ca8210_register_ext_clock(struct spi_device *spi)
2782 struct device_node *np = spi->dev.of_node;
2783 struct ca8210_priv *priv = spi_get_drvdata(spi);
2784 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2790 priv->clk = clk_register_fixed_rate(
2798 if (IS_ERR(priv->clk)) {
2799 dev_crit(&spi->dev, "Failed to register external clk\n");
2800 return PTR_ERR(priv->clk);
2802 ret = of_clk_add_provider(np, of_clk_src_simple_get, priv->clk);
2804 clk_unregister(priv->clk);
2807 "Failed to register external clock as clock provider\n"
2810 dev_info(&spi->dev, "External clock set as clock provider\n");
2817 * ca8210_unregister_ext_clock() - Unregister ca8210's external clock with
2819 * @spi: Pointer to target ca8210 spi device
2821 static void ca8210_unregister_ext_clock(struct spi_device *spi)
2823 struct ca8210_priv *priv = spi_get_drvdata(spi);
2828 of_clk_del_provider(spi->dev.of_node);
2829 clk_unregister(priv->clk);
2830 dev_info(&spi->dev, "External clock unregistered\n");
2834 * ca8210_reset_init() - Initialise the reset input to the ca8210
2835 * @spi: Pointer to target ca8210 spi device
2837 * Return: 0 or linux error code
2839 static int ca8210_reset_init(struct spi_device *spi)
2842 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2844 pdata->gpio_reset = of_get_named_gpio(
2850 ret = gpio_direction_output(pdata->gpio_reset, 1);
2854 "Reset GPIO %d did not set to output mode\n",
2863 * ca8210_interrupt_init() - Initialise the irq output from the ca8210
2864 * @spi: Pointer to target ca8210 spi device
2866 * Return: 0 or linux error code
2868 static int ca8210_interrupt_init(struct spi_device *spi)
2871 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2873 pdata->gpio_irq = of_get_named_gpio(
2879 pdata->irq_id = gpio_to_irq(pdata->gpio_irq);
2880 if (pdata->irq_id < 0) {
2883 "Could not get irq for gpio pin %d\n",
2886 gpio_free(pdata->gpio_irq);
2887 return pdata->irq_id;
2892 ca8210_interrupt_handler,
2893 IRQF_TRIGGER_FALLING,
2895 spi_get_drvdata(spi)
2898 dev_crit(&spi->dev, "request_irq %d failed\n", pdata->irq_id);
2899 gpio_unexport(pdata->gpio_irq);
2900 gpio_free(pdata->gpio_irq);
2907 * ca8210_dev_com_init() - Initialise the spi communication component
2908 * @priv: Pointer to private data structure
2910 * Return: 0 or linux error code
2912 static int ca8210_dev_com_init(struct ca8210_priv *priv)
2914 priv->mlme_workqueue = alloc_ordered_workqueue(
2918 if (!priv->mlme_workqueue) {
2919 dev_crit(&priv->spi->dev, "alloc of mlme_workqueue failed!\n");
2923 priv->irq_workqueue = alloc_ordered_workqueue(
2924 "ca8210 irq worker",
2927 if (!priv->irq_workqueue) {
2928 dev_crit(&priv->spi->dev, "alloc of irq_workqueue failed!\n");
2929 destroy_workqueue(priv->mlme_workqueue);
2937 * ca8210_dev_com_clear() - Deinitialise the spi communication component
2938 * @priv: Pointer to private data structure
2940 static void ca8210_dev_com_clear(struct ca8210_priv *priv)
2942 flush_workqueue(priv->mlme_workqueue);
2943 destroy_workqueue(priv->mlme_workqueue);
2944 flush_workqueue(priv->irq_workqueue);
2945 destroy_workqueue(priv->irq_workqueue);
2948 #define CA8210_MAX_TX_POWERS (9)
2949 static const s32 ca8210_tx_powers[CA8210_MAX_TX_POWERS] = {
2950 800, 700, 600, 500, 400, 300, 200, 100, 0
2953 #define CA8210_MAX_ED_LEVELS (21)
2954 static const s32 ca8210_ed_levels[CA8210_MAX_ED_LEVELS] = {
2955 -10300, -10250, -10200, -10150, -10100, -10050, -10000, -9950, -9900,
2956 -9850, -9800, -9750, -9700, -9650, -9600, -9550, -9500, -9450, -9400,
2961 * ca8210_hw_setup() - Populate the ieee802154_hw phy attributes with the
2963 * @ca8210_hw: Pointer to ieee802154_hw to populate
2965 static void ca8210_hw_setup(struct ieee802154_hw *ca8210_hw)
2967 /* Support channels 11-26 */
2968 ca8210_hw->phy->supported.channels[0] = CA8210_VALID_CHANNELS;
2969 ca8210_hw->phy->supported.tx_powers_size = CA8210_MAX_TX_POWERS;
2970 ca8210_hw->phy->supported.tx_powers = ca8210_tx_powers;
2971 ca8210_hw->phy->supported.cca_ed_levels_size = CA8210_MAX_ED_LEVELS;
2972 ca8210_hw->phy->supported.cca_ed_levels = ca8210_ed_levels;
2973 ca8210_hw->phy->current_channel = 18;
2974 ca8210_hw->phy->current_page = 0;
2975 ca8210_hw->phy->transmit_power = 800;
2976 ca8210_hw->phy->cca.mode = NL802154_CCA_ENERGY_CARRIER;
2977 ca8210_hw->phy->cca.opt = NL802154_CCA_OPT_ENERGY_CARRIER_AND;
2978 ca8210_hw->phy->cca_ed_level = -9800;
2979 ca8210_hw->phy->symbol_duration = 16;
2980 ca8210_hw->phy->lifs_period = 40 * ca8210_hw->phy->symbol_duration;
2981 ca8210_hw->phy->sifs_period = 12 * ca8210_hw->phy->symbol_duration;
2983 IEEE802154_HW_AFILT |
2984 IEEE802154_HW_OMIT_CKSUM |
2985 IEEE802154_HW_FRAME_RETRIES |
2986 IEEE802154_HW_PROMISCUOUS |
2987 IEEE802154_HW_CSMA_PARAMS;
2988 ca8210_hw->phy->flags =
2989 WPAN_PHY_FLAG_TXPOWER |
2990 WPAN_PHY_FLAG_CCA_ED_LEVEL |
2991 WPAN_PHY_FLAG_CCA_MODE;
2995 * ca8210_test_interface_init() - Initialise the test file interface
2996 * @priv: Pointer to private data structure
2998 * Provided as an alternative to the standard linux network interface, the test
2999 * interface exposes a file in the filesystem (ca8210_test) that allows
3000 * 802.15.4 SAP Commands and Cascoda EVBME commands to be sent directly to
3003 * Return: 0 or linux error code
3005 static int ca8210_test_interface_init(struct ca8210_priv *priv)
3007 struct ca8210_test *test = &priv->test;
3014 priv->spi->master->bus_num,
3015 priv->spi->chip_select
3018 test->ca8210_dfs_spi_int = debugfs_create_file(
3020 0600, /* S_IRUSR | S_IWUSR */
3026 debugfs_create_symlink("ca8210", NULL, node_name);
3027 init_waitqueue_head(&test->readq);
3030 CA8210_TEST_INT_FIFO_SIZE,
3036 * ca8210_test_interface_clear() - Deinitialise the test file interface
3037 * @priv: Pointer to private data structure
3039 static void ca8210_test_interface_clear(struct ca8210_priv *priv)
3041 struct ca8210_test *test = &priv->test;
3043 debugfs_remove(test->ca8210_dfs_spi_int);
3044 kfifo_free(&test->up_fifo);
3045 dev_info(&priv->spi->dev, "Test interface removed\n");
3049 * ca8210_remove() - Shut down a ca8210 upon being disconnected
3050 * @priv: Pointer to private data structure
3052 * Return: 0 or linux error code
3054 static int ca8210_remove(struct spi_device *spi_device)
3056 struct ca8210_priv *priv;
3057 struct ca8210_platform_data *pdata;
3059 dev_info(&spi_device->dev, "Removing ca8210\n");
3061 pdata = spi_device->dev.platform_data;
3063 if (pdata->extclockenable) {
3064 ca8210_unregister_ext_clock(spi_device);
3065 ca8210_config_extern_clk(pdata, spi_device, 0);
3067 free_irq(pdata->irq_id, spi_device->dev.driver_data);
3069 spi_device->dev.platform_data = NULL;
3071 /* get spi_device private data */
3072 priv = spi_get_drvdata(spi_device);
3076 "sync_down = %d, sync_up = %d\n",
3080 ca8210_dev_com_clear(spi_device->dev.driver_data);
3082 if (priv->hw_registered)
3083 ieee802154_unregister_hw(priv->hw);
3084 ieee802154_free_hw(priv->hw);
3088 "Unregistered & freed ieee802154_hw.\n"
3091 if (IS_ENABLED(CONFIG_IEEE802154_CA8210_DEBUGFS))
3092 ca8210_test_interface_clear(priv);
3099 * ca8210_probe() - Set up a connected ca8210 upon being detected by the system
3100 * @priv: Pointer to private data structure
3102 * Return: 0 or linux error code
3104 static int ca8210_probe(struct spi_device *spi_device)
3106 struct ca8210_priv *priv;
3107 struct ieee802154_hw *hw;
3108 struct ca8210_platform_data *pdata;
3111 dev_info(&spi_device->dev, "Inserting ca8210\n");
3113 /* allocate ieee802154_hw and private data */
3114 hw = ieee802154_alloc_hw(sizeof(struct ca8210_priv), &ca8210_phy_ops);
3116 dev_crit(&spi_device->dev, "ieee802154_alloc_hw failed\n");
3123 priv->spi = spi_device;
3124 hw->parent = &spi_device->dev;
3125 spin_lock_init(&priv->lock);
3126 priv->async_tx_pending = false;
3127 priv->hw_registered = false;
3129 priv->sync_down = 0;
3130 priv->promiscuous = false;
3132 init_completion(&priv->ca8210_is_awake);
3133 init_completion(&priv->spi_transfer_complete);
3134 init_completion(&priv->sync_exchange_complete);
3135 spi_set_drvdata(priv->spi, priv);
3136 if (IS_ENABLED(CONFIG_IEEE802154_CA8210_DEBUGFS)) {
3137 cascoda_api_upstream = ca8210_test_int_driver_write;
3138 ca8210_test_interface_init(priv);
3140 cascoda_api_upstream = NULL;
3142 ca8210_hw_setup(hw);
3143 ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
3145 pdata = kmalloc(sizeof(*pdata), GFP_KERNEL);
3151 priv->spi->dev.platform_data = pdata;
3152 ret = ca8210_get_platform_data(priv->spi, pdata);
3154 dev_crit(&spi_device->dev, "ca8210_get_platform_data failed\n");
3158 ret = ca8210_dev_com_init(priv);
3160 dev_crit(&spi_device->dev, "ca8210_dev_com_init failed\n");
3163 ret = ca8210_reset_init(priv->spi);
3165 dev_crit(&spi_device->dev, "ca8210_reset_init failed\n");
3169 ret = ca8210_interrupt_init(priv->spi);
3171 dev_crit(&spi_device->dev, "ca8210_interrupt_init failed\n");
3177 ca8210_reset_send(priv->spi, 1);
3179 ret = tdme_chipinit(priv->spi);
3181 dev_crit(&spi_device->dev, "tdme_chipinit failed\n");
3185 if (pdata->extclockenable) {
3186 ret = ca8210_config_extern_clk(pdata, priv->spi, 1);
3190 "ca8210_config_extern_clk failed\n"
3194 ret = ca8210_register_ext_clock(priv->spi);
3198 "ca8210_register_ext_clock failed\n"
3204 ret = ieee802154_register_hw(hw);
3206 dev_crit(&spi_device->dev, "ieee802154_register_hw failed\n");
3209 priv->hw_registered = true;
3213 msleep(100); /* wait for pending spi transfers to complete */
3214 ca8210_remove(spi_device);
3215 return link_to_linux_err(ret);
3218 static const struct of_device_id ca8210_of_ids[] = {
3219 {.compatible = "cascoda,ca8210", },
3222 MODULE_DEVICE_TABLE(of, ca8210_of_ids);
3224 static struct spi_driver ca8210_spi_driver = {
3226 .name = DRIVER_NAME,
3227 .owner = THIS_MODULE,
3228 .of_match_table = of_match_ptr(ca8210_of_ids),
3230 .probe = ca8210_probe,
3231 .remove = ca8210_remove
3234 module_spi_driver(ca8210_spi_driver);
3236 MODULE_AUTHOR("Harry Morris <h.morris@cascoda.com>");
3237 MODULE_DESCRIPTION("CA-8210 SoftMAC driver");
3238 MODULE_LICENSE("Dual BSD/GPL");
3239 MODULE_VERSION("1.0");