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>
56 #include <linux/kfifo.h>
58 #include <linux/of_device.h>
59 #include <linux/of_gpio.h>
60 #include <linux/module.h>
61 #include <linux/mutex.h>
62 #include <linux/poll.h>
63 #include <linux/skbuff.h>
64 #include <linux/slab.h>
65 #include <linux/spi/spi.h>
66 #include <linux/spinlock.h>
67 #include <linux/string.h>
68 #include <linux/workqueue.h>
69 #include <linux/interrupt.h>
71 #include <net/ieee802154_netdev.h>
72 #include <net/mac802154.h>
74 #define DRIVER_NAME "ca8210"
76 /* external clock frequencies */
77 #define ONE_MHZ 1000000
78 #define TWO_MHZ (2 * ONE_MHZ)
79 #define FOUR_MHZ (4 * ONE_MHZ)
80 #define EIGHT_MHZ (8 * ONE_MHZ)
81 #define SIXTEEN_MHZ (16 * ONE_MHZ)
84 #define CA8210_SPI_BUF_SIZE 256
85 #define CA8210_SYNC_TIMEOUT 1000 /* Timeout for synchronous commands [ms] */
87 /* test interface constants */
88 #define CA8210_TEST_INT_FILE_NAME "ca8210_test"
89 #define CA8210_TEST_INT_FIFO_SIZE 256
91 /* MAC status enumerations */
92 #define MAC_SUCCESS (0x00)
93 #define MAC_ERROR (0x01)
94 #define MAC_CANCELLED (0x02)
95 #define MAC_READY_FOR_POLL (0x03)
96 #define MAC_COUNTER_ERROR (0xDB)
97 #define MAC_IMPROPER_KEY_TYPE (0xDC)
98 #define MAC_IMPROPER_SECURITY_LEVEL (0xDD)
99 #define MAC_UNSUPPORTED_LEGACY (0xDE)
100 #define MAC_UNSUPPORTED_SECURITY (0xDF)
101 #define MAC_BEACON_LOST (0xE0)
102 #define MAC_CHANNEL_ACCESS_FAILURE (0xE1)
103 #define MAC_DENIED (0xE2)
104 #define MAC_DISABLE_TRX_FAILURE (0xE3)
105 #define MAC_SECURITY_ERROR (0xE4)
106 #define MAC_FRAME_TOO_LONG (0xE5)
107 #define MAC_INVALID_GTS (0xE6)
108 #define MAC_INVALID_HANDLE (0xE7)
109 #define MAC_INVALID_PARAMETER (0xE8)
110 #define MAC_NO_ACK (0xE9)
111 #define MAC_NO_BEACON (0xEA)
112 #define MAC_NO_DATA (0xEB)
113 #define MAC_NO_SHORT_ADDRESS (0xEC)
114 #define MAC_OUT_OF_CAP (0xED)
115 #define MAC_PAN_ID_CONFLICT (0xEE)
116 #define MAC_REALIGNMENT (0xEF)
117 #define MAC_TRANSACTION_EXPIRED (0xF0)
118 #define MAC_TRANSACTION_OVERFLOW (0xF1)
119 #define MAC_TX_ACTIVE (0xF2)
120 #define MAC_UNAVAILABLE_KEY (0xF3)
121 #define MAC_UNSUPPORTED_ATTRIBUTE (0xF4)
122 #define MAC_INVALID_ADDRESS (0xF5)
123 #define MAC_ON_TIME_TOO_LONG (0xF6)
124 #define MAC_PAST_TIME (0xF7)
125 #define MAC_TRACKING_OFF (0xF8)
126 #define MAC_INVALID_INDEX (0xF9)
127 #define MAC_LIMIT_REACHED (0xFA)
128 #define MAC_READ_ONLY (0xFB)
129 #define MAC_SCAN_IN_PROGRESS (0xFC)
130 #define MAC_SUPERFRAME_OVERLAP (0xFD)
131 #define MAC_SYSTEM_ERROR (0xFF)
133 /* HWME attribute IDs */
134 #define HWME_EDTHRESHOLD (0x04)
135 #define HWME_EDVALUE (0x06)
136 #define HWME_SYSCLKOUT (0x0F)
137 #define HWME_LQILIMIT (0x11)
139 /* TDME attribute IDs */
140 #define TDME_CHANNEL (0x00)
141 #define TDME_ATM_CONFIG (0x06)
143 #define MAX_HWME_ATTRIBUTE_SIZE 16
144 #define MAX_TDME_ATTRIBUTE_SIZE 2
146 /* PHY/MAC PIB Attribute Enumerations */
147 #define PHY_CURRENT_CHANNEL (0x00)
148 #define PHY_TRANSMIT_POWER (0x02)
149 #define PHY_CCA_MODE (0x03)
150 #define MAC_ASSOCIATION_PERMIT (0x41)
151 #define MAC_AUTO_REQUEST (0x42)
152 #define MAC_BATT_LIFE_EXT (0x43)
153 #define MAC_BATT_LIFE_EXT_PERIODS (0x44)
154 #define MAC_BEACON_PAYLOAD (0x45)
155 #define MAC_BEACON_PAYLOAD_LENGTH (0x46)
156 #define MAC_BEACON_ORDER (0x47)
157 #define MAC_GTS_PERMIT (0x4d)
158 #define MAC_MAX_CSMA_BACKOFFS (0x4e)
159 #define MAC_MIN_BE (0x4f)
160 #define MAC_PAN_ID (0x50)
161 #define MAC_PROMISCUOUS_MODE (0x51)
162 #define MAC_RX_ON_WHEN_IDLE (0x52)
163 #define MAC_SHORT_ADDRESS (0x53)
164 #define MAC_SUPERFRAME_ORDER (0x54)
165 #define MAC_ASSOCIATED_PAN_COORD (0x56)
166 #define MAC_MAX_BE (0x57)
167 #define MAC_MAX_FRAME_RETRIES (0x59)
168 #define MAC_RESPONSE_WAIT_TIME (0x5A)
169 #define MAC_SECURITY_ENABLED (0x5D)
171 #define MAC_AUTO_REQUEST_SECURITY_LEVEL (0x78)
172 #define MAC_AUTO_REQUEST_KEY_ID_MODE (0x79)
174 #define NS_IEEE_ADDRESS (0xFF) /* Non-standard IEEE address */
176 /* MAC Address Mode Definitions */
177 #define MAC_MODE_NO_ADDR (0x00)
178 #define MAC_MODE_SHORT_ADDR (0x02)
179 #define MAC_MODE_LONG_ADDR (0x03)
182 #define MAX_BEACON_OVERHEAD (75)
183 #define MAX_BEACON_PAYLOAD_LENGTH (IEEE802154_MTU - MAX_BEACON_OVERHEAD)
185 #define MAX_ATTRIBUTE_SIZE (122)
186 #define MAX_DATA_SIZE (114)
188 #define CA8210_VALID_CHANNELS (0x07FFF800)
190 /* MAC workarounds for V1.1 and MPW silicon (V0.x) */
191 #define CA8210_MAC_WORKAROUNDS (0)
192 #define CA8210_MAC_MPW (0)
194 /* memory manipulation macros */
195 #define LS_BYTE(x) ((u8)((x) & 0xFF))
196 #define MS_BYTE(x) ((u8)(((x) >> 8) & 0xFF))
198 /* message ID codes in SPI commands */
200 #define MCPS_DATA_REQUEST (0x00)
201 #define MLME_ASSOCIATE_REQUEST (0x02)
202 #define MLME_ASSOCIATE_RESPONSE (0x03)
203 #define MLME_DISASSOCIATE_REQUEST (0x04)
204 #define MLME_GET_REQUEST (0x05)
205 #define MLME_ORPHAN_RESPONSE (0x06)
206 #define MLME_RESET_REQUEST (0x07)
207 #define MLME_RX_ENABLE_REQUEST (0x08)
208 #define MLME_SCAN_REQUEST (0x09)
209 #define MLME_SET_REQUEST (0x0A)
210 #define MLME_START_REQUEST (0x0B)
211 #define MLME_POLL_REQUEST (0x0D)
212 #define HWME_SET_REQUEST (0x0E)
213 #define HWME_GET_REQUEST (0x0F)
214 #define TDME_SETSFR_REQUEST (0x11)
215 #define TDME_GETSFR_REQUEST (0x12)
216 #define TDME_SET_REQUEST (0x14)
218 #define MCPS_DATA_INDICATION (0x00)
219 #define MCPS_DATA_CONFIRM (0x01)
220 #define MLME_RESET_CONFIRM (0x0A)
221 #define MLME_SET_CONFIRM (0x0E)
222 #define MLME_START_CONFIRM (0x0F)
223 #define HWME_SET_CONFIRM (0x12)
224 #define HWME_GET_CONFIRM (0x13)
225 #define HWME_WAKEUP_INDICATION (0x15)
226 #define TDME_SETSFR_CONFIRM (0x17)
228 /* SPI command IDs */
229 /* bit indicating a confirm or indication from slave to master */
230 #define SPI_S2M (0x20)
231 /* bit indicating a synchronous message */
232 #define SPI_SYN (0x40)
234 /* SPI command definitions */
235 #define SPI_IDLE (0xFF)
236 #define SPI_NACK (0xF0)
238 #define SPI_MCPS_DATA_REQUEST (MCPS_DATA_REQUEST)
239 #define SPI_MCPS_DATA_INDICATION (MCPS_DATA_INDICATION + SPI_S2M)
240 #define SPI_MCPS_DATA_CONFIRM (MCPS_DATA_CONFIRM + SPI_S2M)
242 #define SPI_MLME_ASSOCIATE_REQUEST (MLME_ASSOCIATE_REQUEST)
243 #define SPI_MLME_RESET_REQUEST (MLME_RESET_REQUEST + SPI_SYN)
244 #define SPI_MLME_SET_REQUEST (MLME_SET_REQUEST + SPI_SYN)
245 #define SPI_MLME_START_REQUEST (MLME_START_REQUEST + SPI_SYN)
246 #define SPI_MLME_RESET_CONFIRM (MLME_RESET_CONFIRM + SPI_S2M + SPI_SYN)
247 #define SPI_MLME_SET_CONFIRM (MLME_SET_CONFIRM + SPI_S2M + SPI_SYN)
248 #define SPI_MLME_START_CONFIRM (MLME_START_CONFIRM + SPI_S2M + SPI_SYN)
250 #define SPI_HWME_SET_REQUEST (HWME_SET_REQUEST + SPI_SYN)
251 #define SPI_HWME_GET_REQUEST (HWME_GET_REQUEST + SPI_SYN)
252 #define SPI_HWME_SET_CONFIRM (HWME_SET_CONFIRM + SPI_S2M + SPI_SYN)
253 #define SPI_HWME_GET_CONFIRM (HWME_GET_CONFIRM + SPI_S2M + SPI_SYN)
254 #define SPI_HWME_WAKEUP_INDICATION (HWME_WAKEUP_INDICATION + SPI_S2M)
256 #define SPI_TDME_SETSFR_REQUEST (TDME_SETSFR_REQUEST + SPI_SYN)
257 #define SPI_TDME_SET_REQUEST (TDME_SET_REQUEST + SPI_SYN)
258 #define SPI_TDME_SETSFR_CONFIRM (TDME_SETSFR_CONFIRM + SPI_S2M + SPI_SYN)
260 /* TDME SFR addresses */
262 #define CA8210_SFR_PACFG (0xB1)
263 #define CA8210_SFR_MACCON (0xD8)
264 #define CA8210_SFR_PACFGIB (0xFE)
266 #define CA8210_SFR_LOTXCAL (0xBF)
267 #define CA8210_SFR_PTHRH (0xD1)
268 #define CA8210_SFR_PRECFG (0xD3)
269 #define CA8210_SFR_LNAGX40 (0xE1)
270 #define CA8210_SFR_LNAGX41 (0xE2)
271 #define CA8210_SFR_LNAGX42 (0xE3)
272 #define CA8210_SFR_LNAGX43 (0xE4)
273 #define CA8210_SFR_LNAGX44 (0xE5)
274 #define CA8210_SFR_LNAGX45 (0xE6)
275 #define CA8210_SFR_LNAGX46 (0xE7)
276 #define CA8210_SFR_LNAGX47 (0xE9)
278 #define PACFGIB_DEFAULT_CURRENT (0x3F)
279 #define PTHRH_DEFAULT_THRESHOLD (0x5A)
280 #define LNAGX40_DEFAULT_GAIN (0x29) /* 10dB */
281 #define LNAGX41_DEFAULT_GAIN (0x54) /* 21dB */
282 #define LNAGX42_DEFAULT_GAIN (0x6C) /* 27dB */
283 #define LNAGX43_DEFAULT_GAIN (0x7A) /* 30dB */
284 #define LNAGX44_DEFAULT_GAIN (0x84) /* 33dB */
285 #define LNAGX45_DEFAULT_GAIN (0x8B) /* 34dB */
286 #define LNAGX46_DEFAULT_GAIN (0x92) /* 36dB */
287 #define LNAGX47_DEFAULT_GAIN (0x96) /* 37dB */
289 #define CA8210_IOCTL_HARD_RESET (0x00)
294 * struct cas_control - spi transfer structure
295 * @msg: spi_message for each exchange
296 * @transfer: spi_transfer for each exchange
297 * @tx_buf: source array for transmission
298 * @tx_in_buf: array storing bytes received during transmission
299 * @priv: pointer to private data
301 * This structure stores all the necessary data passed around during a single
305 struct spi_message msg;
306 struct spi_transfer transfer;
308 u8 tx_buf[CA8210_SPI_BUF_SIZE];
309 u8 tx_in_buf[CA8210_SPI_BUF_SIZE];
311 struct ca8210_priv *priv;
315 * struct ca8210_test - ca8210 test interface structure
316 * @ca8210_dfs_spi_int: pointer to the entry in the debug fs for this device
317 * @up_fifo: fifo for upstream messages
319 * This structure stores all the data pertaining to the debug interface
322 struct dentry *ca8210_dfs_spi_int;
323 struct kfifo up_fifo;
324 wait_queue_head_t readq;
328 * struct ca8210_priv - ca8210 private data structure
329 * @spi: pointer to the ca8210 spi device object
330 * @hw: pointer to the ca8210 ieee802154_hw object
331 * @hw_registered: true if hw has been registered with ieee802154
332 * @lock: spinlock protecting the private data area
333 * @mlme_workqueue: workqueue for triggering MLME Reset
334 * @irq_workqueue: workqueue for irq processing
335 * @tx_skb: current socket buffer to transmit
336 * @nextmsduhandle: msdu handle to pass to the 15.4 MAC layer for the
338 * @clk: external clock provided by the ca8210
339 * @last_dsn: sequence number of last data packet received, for
341 * @test: test interface data section for this instance
342 * @async_tx_pending: true if an asynchronous transmission was started and
344 * @sync_command_response: pointer to buffer to fill with sync response
345 * @ca8210_is_awake: nonzero if ca8210 is initialised, ready for comms
346 * @sync_down: counts number of downstream synchronous commands
347 * @sync_up: counts number of upstream synchronous commands
348 * @spi_transfer_complete completion object for a single spi_transfer
349 * @sync_exchange_complete completion object for a complete synchronous API
351 * @promiscuous whether the ca8210 is in promiscuous mode or not
352 * @retries: records how many times the current pending spi
353 * transfer has been retried
356 struct spi_device *spi;
357 struct ieee802154_hw *hw;
360 struct workqueue_struct *mlme_workqueue;
361 struct workqueue_struct *irq_workqueue;
362 struct sk_buff *tx_skb;
366 struct ca8210_test test;
367 bool async_tx_pending;
368 u8 *sync_command_response;
369 struct completion ca8210_is_awake;
370 int sync_down, sync_up;
371 struct completion spi_transfer_complete, sync_exchange_complete;
377 * struct work_priv_container - link between a work object and the relevant
378 * device's private data
379 * @work: work object being executed
380 * @priv: device's private data section
383 struct work_priv_container {
384 struct work_struct work;
385 struct ca8210_priv *priv;
389 * struct ca8210_platform_data - ca8210 platform data structure
390 * @extclockenable: true if the external clock is to be enabled
391 * @extclockfreq: frequency of the external clock
392 * @extclockgpio: ca8210 output gpio of the external clock
393 * @gpio_reset: gpio number of ca8210 reset line
394 * @gpio_irq: gpio number of ca8210 interrupt line
395 * @irq_id: identifier for the ca8210 irq
398 struct ca8210_platform_data {
400 unsigned int extclockfreq;
401 unsigned int extclockgpio;
408 * struct fulladdr - full MAC addressing information structure
409 * @mode: address mode (none, short, extended)
410 * @pan_id: 16-bit LE pan id
411 * @address: LE address, variable length as specified by mode
421 * union macaddr: generic MAC address container
422 * @short_addr: 16-bit short address
423 * @ieee_address: 64-bit extended address as LE byte array
432 * struct secspec: security specification for SAP commands
433 * @security_level: 0-7, controls level of authentication & encryption
434 * @key_id_mode: 0-3, specifies how to obtain key
435 * @key_source: extended key retrieval data
436 * @key_index: single-byte key identifier
446 /* downlink functions parameter set definitions */
447 struct mcps_data_request_pset {
453 u8 msdu[MAX_DATA_SIZE];
456 struct mlme_set_request_pset {
458 u8 pib_attribute_index;
459 u8 pib_attribute_length;
460 u8 pib_attribute_value[MAX_ATTRIBUTE_SIZE];
463 struct hwme_set_request_pset {
465 u8 hw_attribute_length;
466 u8 hw_attribute_value[MAX_HWME_ATTRIBUTE_SIZE];
469 struct hwme_get_request_pset {
473 struct tdme_setsfr_request_pset {
479 /* uplink functions parameter set definitions */
480 struct hwme_set_confirm_pset {
485 struct hwme_get_confirm_pset {
488 u8 hw_attribute_length;
489 u8 hw_attribute_value[MAX_HWME_ATTRIBUTE_SIZE];
492 struct tdme_setsfr_confirm_pset {
502 struct mcps_data_request_pset data_req;
503 struct mlme_set_request_pset set_req;
504 struct hwme_set_request_pset hwme_set_req;
505 struct hwme_get_request_pset hwme_get_req;
506 struct tdme_setsfr_request_pset tdme_set_sfr_req;
507 struct hwme_set_confirm_pset hwme_set_cnf;
508 struct hwme_get_confirm_pset hwme_get_cnf;
509 struct tdme_setsfr_confirm_pset tdme_set_sfr_cnf;
518 u8 bias_current_trim : 3;
519 u8 /* reserved */ : 1;
520 u8 buffer_capacitor_trim : 3;
526 struct preamble_cfg_sfr {
527 u8 timeout_symbols : 3;
528 u8 acquisition_symbols : 3;
529 u8 search_symbols : 2;
532 static int (*cascoda_api_upstream)(
539 * link_to_linux_err() - Translates an 802.15.4 return code into the closest
541 * @link_status: 802.15.4 status code
543 * Return: 0 or Linux error code
545 static int link_to_linux_err(int link_status)
547 if (link_status < 0) {
548 /* status is already a Linux code */
551 switch (link_status) {
553 case MAC_REALIGNMENT:
555 case MAC_IMPROPER_KEY_TYPE:
556 return -EKEYREJECTED;
557 case MAC_IMPROPER_SECURITY_LEVEL:
558 case MAC_UNSUPPORTED_LEGACY:
561 case MAC_BEACON_LOST:
565 case MAC_CHANNEL_ACCESS_FAILURE:
567 case MAC_SCAN_IN_PROGRESS:
569 case MAC_DISABLE_TRX_FAILURE:
572 case MAC_FRAME_TOO_LONG:
574 case MAC_INVALID_GTS:
577 case MAC_INVALID_HANDLE:
579 case MAC_INVALID_PARAMETER:
580 case MAC_UNSUPPORTED_ATTRIBUTE:
581 case MAC_ON_TIME_TOO_LONG:
582 case MAC_INVALID_INDEX:
586 case MAC_NO_SHORT_ADDRESS:
588 case MAC_PAN_ID_CONFLICT:
590 case MAC_TRANSACTION_EXPIRED:
592 case MAC_TRANSACTION_OVERFLOW:
594 case MAC_UNAVAILABLE_KEY:
596 case MAC_INVALID_ADDRESS:
598 case MAC_TRACKING_OFF:
599 case MAC_SUPERFRAME_OVERLAP:
601 case MAC_LIMIT_REACHED:
611 * ca8210_test_int_driver_write() - Writes a message to the test interface to be
612 * read by the userspace
613 * @buf: Buffer containing upstream message
614 * @len: length of message to write
615 * @spi: SPI device of message originator
617 * Return: 0 or linux error code
619 static int ca8210_test_int_driver_write(
625 struct ca8210_priv *priv = spi_get_drvdata(spi);
626 struct ca8210_test *test = &priv->test;
632 "test_interface: Buffering upstream message:\n"
634 for (i = 0; i < len; i++)
635 dev_dbg(&priv->spi->dev, "%#03x\n", buf[i]);
637 fifo_buffer = kmalloc(len, GFP_KERNEL);
640 memcpy(fifo_buffer, buf, len);
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, "ca8210_spi_transfer called\n");
929 cas_ctl = kzalloc(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_usecs = 0;
950 cas_ctl->transfer.cs_change = 0;
951 cas_ctl->transfer.len = sizeof(struct mac_message);
952 cas_ctl->msg.complete = ca8210_spi_transfer_complete;
953 cas_ctl->msg.context = cas_ctl;
955 spi_message_add_tail(
960 status = spi_async(spi, &cas_ctl->msg);
964 "status %d from spi_sync in write\n",
973 * ca8210_spi_exchange() - Exchange API/SAP commands with the radio
974 * @buf: Octet array of command being sent downstream
975 * @len: length of buf
976 * @response: buffer for storing synchronous response
977 * @device_ref: spi_device pointer for ca8210
979 * Effectively calls ca8210_spi_transfer to write buf[] to the spi, then for
980 * synchronous commands waits for the corresponding response to be read from
981 * the spi before returning. The response is written to the response parameter.
983 * Return: 0 or linux error code
985 static int ca8210_spi_exchange(
993 struct spi_device *spi = device_ref;
994 struct ca8210_priv *priv = spi->dev.driver_data;
997 if ((buf[0] & SPI_SYN) && response) { /* if sync wait for confirm */
998 reinit_completion(&priv->sync_exchange_complete);
999 priv->sync_command_response = response;
1003 reinit_completion(&priv->spi_transfer_complete);
1004 status = ca8210_spi_transfer(priv->spi, buf, len);
1008 "spi write failed, returned %d\n",
1011 if (status == -EBUSY)
1013 if (((buf[0] & SPI_SYN) && response))
1014 complete(&priv->sync_exchange_complete);
1018 wait_remaining = wait_for_completion_interruptible_timeout(
1019 &priv->spi_transfer_complete,
1020 msecs_to_jiffies(1000)
1022 if (wait_remaining == -ERESTARTSYS) {
1023 status = -ERESTARTSYS;
1024 } else if (wait_remaining == 0) {
1027 "SPI downstream transfer timed out!\n"
1032 } while (status < 0);
1034 if (!((buf[0] & SPI_SYN) && response))
1037 wait_remaining = wait_for_completion_interruptible_timeout(
1038 &priv->sync_exchange_complete,
1039 msecs_to_jiffies(CA8210_SYNC_TIMEOUT)
1041 if (wait_remaining == -ERESTARTSYS) {
1042 status = -ERESTARTSYS;
1043 } else if (wait_remaining == 0) {
1046 "Synchronous confirm timeout\n"
1052 priv->sync_command_response = NULL;
1057 * ca8210_interrupt_handler() - Called when an irq is received from the ca8210
1058 * @irq: Id of the irq being handled
1059 * @dev_id: Pointer passed by the system, pointing to the ca8210's private data
1061 * This function is called when the irq line from the ca8210 is asserted,
1062 * signifying that the ca8210 has a message to send upstream to us. Starts the
1063 * asynchronous spi read.
1065 * Return: irq return code
1067 static irqreturn_t ca8210_interrupt_handler(int irq, void *dev_id)
1069 struct ca8210_priv *priv = dev_id;
1072 dev_dbg(&priv->spi->dev, "irq: Interrupt occurred\n");
1074 status = ca8210_spi_transfer(priv->spi, NULL, 0);
1075 if (status && (status != -EBUSY)) {
1078 "spi read failed, returned %d\n",
1082 } while (status == -EBUSY);
1086 static int (*cascoda_api_downstream)(
1091 ) = ca8210_spi_exchange;
1093 /* Cascoda API / 15.4 SAP Primitives */
1096 * tdme_setsfr_request_sync() - TDME_SETSFR_request/confirm according to API
1097 * @sfr_page: SFR Page
1098 * @sfr_address: SFR Address
1099 * @sfr_value: SFR Value
1100 * @device_ref: Nondescript pointer to target device
1102 * Return: 802.15.4 status code of TDME-SETSFR.confirm
1104 static u8 tdme_setsfr_request_sync(
1112 struct mac_message command, response;
1113 struct spi_device *spi = device_ref;
1115 command.command_id = SPI_TDME_SETSFR_REQUEST;
1117 command.pdata.tdme_set_sfr_req.sfr_page = sfr_page;
1118 command.pdata.tdme_set_sfr_req.sfr_address = sfr_address;
1119 command.pdata.tdme_set_sfr_req.sfr_value = sfr_value;
1120 response.command_id = SPI_IDLE;
1121 ret = cascoda_api_downstream(
1122 &command.command_id,
1124 &response.command_id,
1128 dev_crit(&spi->dev, "cascoda_api_downstream returned %d", ret);
1129 return MAC_SYSTEM_ERROR;
1132 if (response.command_id != SPI_TDME_SETSFR_CONFIRM) {
1135 "sync response to SPI_TDME_SETSFR_REQUEST was not SPI_TDME_SETSFR_CONFIRM, it was %d\n",
1138 return MAC_SYSTEM_ERROR;
1141 return response.pdata.tdme_set_sfr_cnf.status;
1145 * tdme_chipinit() - TDME Chip Register Default Initialisation Macro
1146 * @device_ref: Nondescript pointer to target device
1148 * Return: 802.15.4 status code of API calls
1150 static u8 tdme_chipinit(void *device_ref)
1152 u8 status = MAC_SUCCESS;
1154 struct spi_device *spi = device_ref;
1155 struct preamble_cfg_sfr pre_cfg_value = {
1156 .timeout_symbols = 3,
1157 .acquisition_symbols = 3,
1158 .search_symbols = 1,
1160 /* LNA Gain Settings */
1161 status = tdme_setsfr_request_sync(
1162 1, (sfr_address = CA8210_SFR_LNAGX40),
1163 LNAGX40_DEFAULT_GAIN, device_ref);
1166 status = tdme_setsfr_request_sync(
1167 1, (sfr_address = CA8210_SFR_LNAGX41),
1168 LNAGX41_DEFAULT_GAIN, device_ref);
1171 status = tdme_setsfr_request_sync(
1172 1, (sfr_address = CA8210_SFR_LNAGX42),
1173 LNAGX42_DEFAULT_GAIN, device_ref);
1176 status = tdme_setsfr_request_sync(
1177 1, (sfr_address = CA8210_SFR_LNAGX43),
1178 LNAGX43_DEFAULT_GAIN, device_ref);
1181 status = tdme_setsfr_request_sync(
1182 1, (sfr_address = CA8210_SFR_LNAGX44),
1183 LNAGX44_DEFAULT_GAIN, device_ref);
1186 status = tdme_setsfr_request_sync(
1187 1, (sfr_address = CA8210_SFR_LNAGX45),
1188 LNAGX45_DEFAULT_GAIN, device_ref);
1191 status = tdme_setsfr_request_sync(
1192 1, (sfr_address = CA8210_SFR_LNAGX46),
1193 LNAGX46_DEFAULT_GAIN, device_ref);
1196 status = tdme_setsfr_request_sync(
1197 1, (sfr_address = CA8210_SFR_LNAGX47),
1198 LNAGX47_DEFAULT_GAIN, device_ref);
1201 /* Preamble Timing Config */
1202 status = tdme_setsfr_request_sync(
1203 1, (sfr_address = CA8210_SFR_PRECFG),
1204 *((u8 *)&pre_cfg_value), device_ref);
1207 /* Preamble Threshold High */
1208 status = tdme_setsfr_request_sync(
1209 1, (sfr_address = CA8210_SFR_PTHRH),
1210 PTHRH_DEFAULT_THRESHOLD, device_ref);
1213 /* Tx Output Power 8 dBm */
1214 status = tdme_setsfr_request_sync(
1215 0, (sfr_address = CA8210_SFR_PACFGIB),
1216 PACFGIB_DEFAULT_CURRENT, device_ref);
1221 if (status != MAC_SUCCESS) {
1224 "failed to set sfr at %#03x, status = %#03x\n",
1233 * tdme_channelinit() - TDME Channel Register Default Initialisation Macro (Tx)
1234 * @channel: 802.15.4 channel to initialise chip for
1235 * @device_ref: Nondescript pointer to target device
1237 * Return: 802.15.4 status code of API calls
1239 static u8 tdme_channelinit(u8 channel, void *device_ref)
1241 /* Transceiver front-end local oscillator tx two-point calibration
1242 * value. Tuned for the hardware.
1248 else if (channel >= 23)
1250 else if (channel >= 22)
1252 else if (channel >= 20)
1254 else if (channel >= 17)
1256 else if (channel >= 16)
1258 else if (channel >= 14)
1260 else if (channel >= 12)
1265 return tdme_setsfr_request_sync(
1274 * tdme_checkpibattribute() - Checks Attribute Values that are not checked in
1276 * @pib_attribute: Attribute Number
1277 * @pib_attribute_length: Attribute length
1278 * @pib_attribute_value: Pointer to Attribute Value
1279 * @device_ref: Nondescript pointer to target device
1281 * Return: 802.15.4 status code of checks
1283 static u8 tdme_checkpibattribute(
1285 u8 pib_attribute_length,
1286 const void *pib_attribute_value
1289 u8 status = MAC_SUCCESS;
1292 value = *((u8 *)pib_attribute_value);
1294 switch (pib_attribute) {
1296 case PHY_TRANSMIT_POWER:
1298 status = MAC_INVALID_PARAMETER;
1302 status = MAC_INVALID_PARAMETER;
1305 case MAC_BATT_LIFE_EXT_PERIODS:
1306 if ((value < 6) || (value > 41))
1307 status = MAC_INVALID_PARAMETER;
1309 case MAC_BEACON_PAYLOAD:
1310 if (pib_attribute_length > MAX_BEACON_PAYLOAD_LENGTH)
1311 status = MAC_INVALID_PARAMETER;
1313 case MAC_BEACON_PAYLOAD_LENGTH:
1314 if (value > MAX_BEACON_PAYLOAD_LENGTH)
1315 status = MAC_INVALID_PARAMETER;
1317 case MAC_BEACON_ORDER:
1319 status = MAC_INVALID_PARAMETER;
1322 if ((value < 3) || (value > 8))
1323 status = MAC_INVALID_PARAMETER;
1325 case MAC_MAX_CSMA_BACKOFFS:
1327 status = MAC_INVALID_PARAMETER;
1329 case MAC_MAX_FRAME_RETRIES:
1331 status = MAC_INVALID_PARAMETER;
1335 status = MAC_INVALID_PARAMETER;
1337 case MAC_RESPONSE_WAIT_TIME:
1338 if ((value < 2) || (value > 64))
1339 status = MAC_INVALID_PARAMETER;
1341 case MAC_SUPERFRAME_ORDER:
1343 status = MAC_INVALID_PARAMETER;
1346 case MAC_ASSOCIATED_PAN_COORD:
1347 case MAC_ASSOCIATION_PERMIT:
1348 case MAC_AUTO_REQUEST:
1349 case MAC_BATT_LIFE_EXT:
1350 case MAC_GTS_PERMIT:
1351 case MAC_PROMISCUOUS_MODE:
1352 case MAC_RX_ON_WHEN_IDLE:
1353 case MAC_SECURITY_ENABLED:
1355 status = MAC_INVALID_PARAMETER;
1358 case MAC_AUTO_REQUEST_SECURITY_LEVEL:
1360 status = MAC_INVALID_PARAMETER;
1362 case MAC_AUTO_REQUEST_KEY_ID_MODE:
1364 status = MAC_INVALID_PARAMETER;
1374 * tdme_settxpower() - Sets the tx power for MLME_SET phyTransmitPower
1375 * @txp: Transmit Power
1376 * @device_ref: Nondescript pointer to target device
1378 * Normalised to 802.15.4 Definition (6-bit, signed):
1380 * Bit 5-0: tx power (-32 - +31 dB)
1382 * Return: 802.15.4 status code of api calls
1384 static u8 tdme_settxpower(u8 txp, void *device_ref)
1389 union pa_cfg_sfr pa_cfg_val;
1391 /* extend from 6 to 8 bit */
1392 txp_ext = 0x3F & txp;
1395 txp_val = (s8)txp_ext;
1397 if (CA8210_MAC_MPW) {
1399 /* 8 dBm: ptrim = 5, itrim = +3 => +4 dBm */
1400 pa_cfg_val.bias_current_trim = 3;
1401 pa_cfg_val.buffer_capacitor_trim = 5;
1402 pa_cfg_val.boost = 1;
1404 /* 0 dBm: ptrim = 7, itrim = +3 => -6 dBm */
1405 pa_cfg_val.bias_current_trim = 3;
1406 pa_cfg_val.buffer_capacitor_trim = 7;
1407 pa_cfg_val.boost = 0;
1410 status = tdme_setsfr_request_sync(
1417 /* Look-Up Table for Setting Current and Frequency Trim values
1418 * for desired Output Power
1421 pa_cfg_val.paib = 0x3F;
1422 } else if (txp_val == 8) {
1423 pa_cfg_val.paib = 0x32;
1424 } else if (txp_val == 7) {
1425 pa_cfg_val.paib = 0x22;
1426 } else if (txp_val == 6) {
1427 pa_cfg_val.paib = 0x18;
1428 } else if (txp_val == 5) {
1429 pa_cfg_val.paib = 0x10;
1430 } else if (txp_val == 4) {
1431 pa_cfg_val.paib = 0x0C;
1432 } else if (txp_val == 3) {
1433 pa_cfg_val.paib = 0x08;
1434 } else if (txp_val == 2) {
1435 pa_cfg_val.paib = 0x05;
1436 } else if (txp_val == 1) {
1437 pa_cfg_val.paib = 0x03;
1438 } else if (txp_val == 0) {
1439 pa_cfg_val.paib = 0x01;
1441 pa_cfg_val.paib = 0x00;
1444 status = tdme_setsfr_request_sync(
1456 * mcps_data_request() - mcps_data_request (Send Data) according to API Spec
1457 * @src_addr_mode: Source Addressing Mode
1458 * @dst_address_mode: Destination Addressing Mode
1459 * @dst_pan_id: Destination PAN ID
1460 * @dst_addr: Pointer to Destination Address
1461 * @msdu_length: length of Data
1462 * @msdu: Pointer to Data
1463 * @msdu_handle: Handle of Data
1464 * @tx_options: Tx Options Bit Field
1465 * @security: Pointer to Security Structure or NULL
1466 * @device_ref: Nondescript pointer to target device
1468 * Return: 802.15.4 status code of action
1470 static u8 mcps_data_request(
1472 u8 dst_address_mode,
1474 union macaddr *dst_addr,
1479 struct secspec *security,
1483 struct secspec *psec;
1484 struct mac_message command;
1486 command.command_id = SPI_MCPS_DATA_REQUEST;
1487 command.pdata.data_req.src_addr_mode = src_addr_mode;
1488 command.pdata.data_req.dst.mode = dst_address_mode;
1489 if (dst_address_mode != MAC_MODE_NO_ADDR) {
1490 command.pdata.data_req.dst.pan_id[0] = LS_BYTE(dst_pan_id);
1491 command.pdata.data_req.dst.pan_id[1] = MS_BYTE(dst_pan_id);
1492 if (dst_address_mode == MAC_MODE_SHORT_ADDR) {
1493 command.pdata.data_req.dst.address[0] = LS_BYTE(
1494 dst_addr->short_address
1496 command.pdata.data_req.dst.address[1] = MS_BYTE(
1497 dst_addr->short_address
1499 } else { /* MAC_MODE_LONG_ADDR*/
1501 command.pdata.data_req.dst.address,
1502 dst_addr->ieee_address,
1507 command.pdata.data_req.msdu_length = msdu_length;
1508 command.pdata.data_req.msdu_handle = msdu_handle;
1509 command.pdata.data_req.tx_options = tx_options;
1510 memcpy(command.pdata.data_req.msdu, msdu, msdu_length);
1511 psec = (struct secspec *)(command.pdata.data_req.msdu + msdu_length);
1512 command.length = sizeof(struct mcps_data_request_pset) -
1513 MAX_DATA_SIZE + msdu_length;
1514 if (!security || (security->security_level == 0)) {
1515 psec->security_level = 0;
1516 command.length += 1;
1519 command.length += sizeof(struct secspec);
1522 if (ca8210_spi_transfer(device_ref, &command.command_id,
1523 command.length + 2))
1524 return MAC_SYSTEM_ERROR;
1530 * mlme_reset_request_sync() - MLME_RESET_request/confirm according to API Spec
1531 * @set_default_pib: Set defaults in PIB
1532 * @device_ref: Nondescript pointer to target device
1534 * Return: 802.15.4 status code of MLME-RESET.confirm
1536 static u8 mlme_reset_request_sync(
1542 struct mac_message command, response;
1543 struct spi_device *spi = device_ref;
1545 command.command_id = SPI_MLME_RESET_REQUEST;
1547 command.pdata.u8param = set_default_pib;
1549 if (cascoda_api_downstream(
1550 &command.command_id,
1552 &response.command_id,
1554 dev_err(&spi->dev, "cascoda_api_downstream failed\n");
1555 return MAC_SYSTEM_ERROR;
1558 if (response.command_id != SPI_MLME_RESET_CONFIRM)
1559 return MAC_SYSTEM_ERROR;
1561 status = response.pdata.status;
1563 /* reset COORD Bit for Channel Filtering as Coordinator */
1564 if (CA8210_MAC_WORKAROUNDS && set_default_pib && (!status)) {
1565 status = tdme_setsfr_request_sync(
1577 * mlme_set_request_sync() - MLME_SET_request/confirm according to API Spec
1578 * @pib_attribute: Attribute Number
1579 * @pib_attribute_index: Index within Attribute if an Array
1580 * @pib_attribute_length: Attribute length
1581 * @pib_attribute_value: Pointer to Attribute Value
1582 * @device_ref: Nondescript pointer to target device
1584 * Return: 802.15.4 status code of MLME-SET.confirm
1586 static u8 mlme_set_request_sync(
1588 u8 pib_attribute_index,
1589 u8 pib_attribute_length,
1590 const void *pib_attribute_value,
1595 struct mac_message command, response;
1597 /* pre-check the validity of pib_attribute values that are not checked
1600 if (tdme_checkpibattribute(
1601 pib_attribute, pib_attribute_length, pib_attribute_value)) {
1602 return MAC_INVALID_PARAMETER;
1605 if (pib_attribute == PHY_CURRENT_CHANNEL) {
1606 status = tdme_channelinit(
1607 *((u8 *)pib_attribute_value),
1614 if (pib_attribute == PHY_TRANSMIT_POWER) {
1615 return tdme_settxpower(
1616 *((u8 *)pib_attribute_value),
1621 command.command_id = SPI_MLME_SET_REQUEST;
1622 command.length = sizeof(struct mlme_set_request_pset) -
1623 MAX_ATTRIBUTE_SIZE + pib_attribute_length;
1624 command.pdata.set_req.pib_attribute = pib_attribute;
1625 command.pdata.set_req.pib_attribute_index = pib_attribute_index;
1626 command.pdata.set_req.pib_attribute_length = pib_attribute_length;
1628 command.pdata.set_req.pib_attribute_value,
1629 pib_attribute_value,
1630 pib_attribute_length
1633 if (cascoda_api_downstream(
1634 &command.command_id,
1636 &response.command_id,
1638 return MAC_SYSTEM_ERROR;
1641 if (response.command_id != SPI_MLME_SET_CONFIRM)
1642 return MAC_SYSTEM_ERROR;
1644 return response.pdata.status;
1648 * hwme_set_request_sync() - HWME_SET_request/confirm according to API Spec
1649 * @hw_attribute: Attribute Number
1650 * @hw_attribute_length: Attribute length
1651 * @hw_attribute_value: Pointer to Attribute Value
1652 * @device_ref: Nondescript pointer to target device
1654 * Return: 802.15.4 status code of HWME-SET.confirm
1656 static u8 hwme_set_request_sync(
1658 u8 hw_attribute_length,
1659 u8 *hw_attribute_value,
1663 struct mac_message command, response;
1665 command.command_id = SPI_HWME_SET_REQUEST;
1666 command.length = 2 + hw_attribute_length;
1667 command.pdata.hwme_set_req.hw_attribute = hw_attribute;
1668 command.pdata.hwme_set_req.hw_attribute_length = hw_attribute_length;
1670 command.pdata.hwme_set_req.hw_attribute_value,
1675 if (cascoda_api_downstream(
1676 &command.command_id,
1678 &response.command_id,
1680 return MAC_SYSTEM_ERROR;
1683 if (response.command_id != SPI_HWME_SET_CONFIRM)
1684 return MAC_SYSTEM_ERROR;
1686 return response.pdata.hwme_set_cnf.status;
1690 * hwme_get_request_sync() - HWME_GET_request/confirm according to API Spec
1691 * @hw_attribute: Attribute Number
1692 * @hw_attribute_length: Attribute length
1693 * @hw_attribute_value: Pointer to Attribute Value
1694 * @device_ref: Nondescript pointer to target device
1696 * Return: 802.15.4 status code of HWME-GET.confirm
1698 static u8 hwme_get_request_sync(
1700 u8 *hw_attribute_length,
1701 u8 *hw_attribute_value,
1705 struct mac_message command, response;
1707 command.command_id = SPI_HWME_GET_REQUEST;
1709 command.pdata.hwme_get_req.hw_attribute = hw_attribute;
1711 if (cascoda_api_downstream(
1712 &command.command_id,
1714 &response.command_id,
1716 return MAC_SYSTEM_ERROR;
1719 if (response.command_id != SPI_HWME_GET_CONFIRM)
1720 return MAC_SYSTEM_ERROR;
1722 if (response.pdata.hwme_get_cnf.status == MAC_SUCCESS) {
1723 *hw_attribute_length =
1724 response.pdata.hwme_get_cnf.hw_attribute_length;
1727 response.pdata.hwme_get_cnf.hw_attribute_value,
1728 *hw_attribute_length
1732 return response.pdata.hwme_get_cnf.status;
1735 /* Network driver operation */
1738 * ca8210_async_xmit_complete() - Called to announce that an asynchronous
1739 * transmission has finished
1740 * @hw: ieee802154_hw of ca8210 that has finished exchange
1741 * @msduhandle: Identifier of transmission that has completed
1742 * @status: Returned 802.15.4 status code of the transmission
1744 * Return: 0 or linux error code
1746 static int ca8210_async_xmit_complete(
1747 struct ieee802154_hw *hw,
1751 struct ca8210_priv *priv = hw->priv;
1753 if (priv->nextmsduhandle != msduhandle) {
1756 "Unexpected msdu_handle on data confirm, Expected %d, got %d\n",
1757 priv->nextmsduhandle,
1763 priv->async_tx_pending = false;
1764 priv->nextmsduhandle++;
1769 "Link transmission unsuccessful, status = %d\n",
1772 if (status != MAC_TRANSACTION_OVERFLOW) {
1773 dev_kfree_skb_any(priv->tx_skb);
1774 ieee802154_wake_queue(priv->hw);
1778 ieee802154_xmit_complete(priv->hw, priv->tx_skb, true);
1784 * ca8210_skb_rx() - Contructs a properly framed socket buffer from a received
1785 * MCPS_DATA_indication
1786 * @hw: ieee802154_hw that MCPS_DATA_indication was received by
1787 * @len: length of MCPS_DATA_indication
1788 * @data_ind: Octet array of MCPS_DATA_indication
1790 * Called by the spi driver whenever a SAP command is received, this function
1791 * will ascertain whether the command is of interest to the network driver and
1792 * take necessary action.
1794 * Return: 0 or linux error code
1796 static int ca8210_skb_rx(
1797 struct ieee802154_hw *hw,
1802 struct ieee802154_hdr hdr;
1805 u8 mpdulinkquality = data_ind[23];
1806 struct sk_buff *skb;
1807 struct ca8210_priv *priv = hw->priv;
1809 /* Allocate mtu size buffer for every rx packet */
1810 skb = dev_alloc_skb(IEEE802154_MTU + sizeof(hdr));
1814 skb_reserve(skb, sizeof(hdr));
1816 msdulen = data_ind[22]; /* msdu_length */
1817 if (msdulen > IEEE802154_MTU) {
1820 "received erroneously large msdu length!\n"
1825 dev_dbg(&priv->spi->dev, "skb buffer length = %d\n", msdulen);
1827 if (priv->promiscuous)
1831 hdr.sec.level = data_ind[29 + msdulen];
1832 dev_dbg(&priv->spi->dev, "security level: %#03x\n", hdr.sec.level);
1833 if (hdr.sec.level > 0) {
1834 hdr.sec.key_id_mode = data_ind[30 + msdulen];
1835 memcpy(&hdr.sec.extended_src, &data_ind[31 + msdulen], 8);
1836 hdr.sec.key_id = data_ind[39 + msdulen];
1838 hdr.source.mode = data_ind[0];
1839 dev_dbg(&priv->spi->dev, "srcAddrMode: %#03x\n", hdr.source.mode);
1840 hdr.source.pan_id = *(u16 *)&data_ind[1];
1841 dev_dbg(&priv->spi->dev, "srcPanId: %#06x\n", hdr.source.pan_id);
1842 memcpy(&hdr.source.extended_addr, &data_ind[3], 8);
1843 hdr.dest.mode = data_ind[11];
1844 dev_dbg(&priv->spi->dev, "dstAddrMode: %#03x\n", hdr.dest.mode);
1845 hdr.dest.pan_id = *(u16 *)&data_ind[12];
1846 dev_dbg(&priv->spi->dev, "dstPanId: %#06x\n", hdr.dest.pan_id);
1847 memcpy(&hdr.dest.extended_addr, &data_ind[14], 8);
1849 /* Fill in FC implicitly */
1850 hdr.fc.type = 1; /* Data frame */
1852 hdr.fc.security_enabled = 1;
1854 hdr.fc.security_enabled = 0;
1855 if (data_ind[1] != data_ind[12] || data_ind[2] != data_ind[13])
1856 hdr.fc.intra_pan = 1;
1858 hdr.fc.intra_pan = 0;
1859 hdr.fc.dest_addr_mode = hdr.dest.mode;
1860 hdr.fc.source_addr_mode = hdr.source.mode;
1862 /* Add hdr to front of buffer */
1863 hlen = ieee802154_hdr_push(skb, &hdr);
1866 dev_crit(&priv->spi->dev, "failed to push mac hdr onto skb!\n");
1871 skb_reset_mac_header(skb);
1872 skb->mac_len = hlen;
1875 /* Add <msdulen> bytes of space to the back of the buffer */
1876 /* Copy msdu to skb */
1877 skb_put_data(skb, &data_ind[29], msdulen);
1879 ieee802154_rx_irqsafe(hw, skb, mpdulinkquality);
1884 * ca8210_net_rx() - Acts upon received SAP commands relevant to the network
1886 * @hw: ieee802154_hw that command was received by
1887 * @command: Octet array of received command
1888 * @len: length of the received command
1890 * Called by the spi driver whenever a SAP command is received, this function
1891 * will ascertain whether the command is of interest to the network driver and
1892 * take necessary action.
1894 * Return: 0 or linux error code
1896 static int ca8210_net_rx(struct ieee802154_hw *hw, u8 *command, size_t len)
1898 struct ca8210_priv *priv = hw->priv;
1899 unsigned long flags;
1902 dev_dbg(&priv->spi->dev, "ca8210_net_rx(), CmdID = %d\n", command[0]);
1904 if (command[0] == SPI_MCPS_DATA_INDICATION) {
1906 spin_lock_irqsave(&priv->lock, flags);
1907 if (command[26] == priv->last_dsn) {
1910 "DSN %d resend received, ignoring...\n",
1913 spin_unlock_irqrestore(&priv->lock, flags);
1916 priv->last_dsn = command[26];
1917 spin_unlock_irqrestore(&priv->lock, flags);
1918 return ca8210_skb_rx(hw, len - 2, command + 2);
1919 } else if (command[0] == SPI_MCPS_DATA_CONFIRM) {
1920 status = command[3];
1921 if (priv->async_tx_pending) {
1922 return ca8210_async_xmit_complete(
1934 * ca8210_skb_tx() - Transmits a given socket buffer using the ca8210
1935 * @skb: Socket buffer to transmit
1936 * @msduhandle: Data identifier to pass to the 802.15.4 MAC
1937 * @priv: Pointer to private data section of target ca8210
1939 * Return: 0 or linux error code
1941 static int ca8210_skb_tx(
1942 struct sk_buff *skb,
1944 struct ca8210_priv *priv
1947 struct ieee802154_hdr header = { 0 };
1948 struct secspec secspec;
1949 int mac_len, status;
1951 dev_dbg(&priv->spi->dev, "ca8210_skb_tx() called\n");
1953 /* Get addressing info from skb - ieee802154 layer creates a full
1956 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 ca8210_xmit_async()\n");
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 unsigned int ca8210_test_int_poll(
2653 struct poll_table_struct *ptable
2656 unsigned int 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 |= (POLLIN | POLLRDNORM);
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;
2789 priv->clk = clk_register_fixed_rate(
2797 if (IS_ERR(priv->clk)) {
2798 dev_crit(&spi->dev, "Failed to register external clk\n");
2799 return PTR_ERR(priv->clk);
2802 return of_clk_add_provider(np, of_clk_src_simple_get, priv->clk);
2806 * ca8210_unregister_ext_clock() - Unregister ca8210's external clock with
2808 * @spi: Pointer to target ca8210 spi device
2810 static void ca8210_unregister_ext_clock(struct spi_device *spi)
2812 struct ca8210_priv *priv = spi_get_drvdata(spi);
2814 if (IS_ERR_OR_NULL(priv->clk))
2817 of_clk_del_provider(spi->dev.of_node);
2818 clk_unregister(priv->clk);
2819 dev_info(&spi->dev, "External clock unregistered\n");
2823 * ca8210_reset_init() - Initialise the reset input to the ca8210
2824 * @spi: Pointer to target ca8210 spi device
2826 * Return: 0 or linux error code
2828 static int ca8210_reset_init(struct spi_device *spi)
2831 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2833 pdata->gpio_reset = of_get_named_gpio(
2839 ret = gpio_direction_output(pdata->gpio_reset, 1);
2843 "Reset GPIO %d did not set to output mode\n",
2852 * ca8210_interrupt_init() - Initialise the irq output from the ca8210
2853 * @spi: Pointer to target ca8210 spi device
2855 * Return: 0 or linux error code
2857 static int ca8210_interrupt_init(struct spi_device *spi)
2860 struct ca8210_platform_data *pdata = spi->dev.platform_data;
2862 pdata->gpio_irq = of_get_named_gpio(
2868 pdata->irq_id = gpio_to_irq(pdata->gpio_irq);
2869 if (pdata->irq_id < 0) {
2872 "Could not get irq for gpio pin %d\n",
2875 gpio_free(pdata->gpio_irq);
2876 return pdata->irq_id;
2881 ca8210_interrupt_handler,
2882 IRQF_TRIGGER_FALLING,
2884 spi_get_drvdata(spi)
2887 dev_crit(&spi->dev, "request_irq %d failed\n", pdata->irq_id);
2888 gpio_unexport(pdata->gpio_irq);
2889 gpio_free(pdata->gpio_irq);
2896 * ca8210_dev_com_init() - Initialise the spi communication component
2897 * @priv: Pointer to private data structure
2899 * Return: 0 or linux error code
2901 static int ca8210_dev_com_init(struct ca8210_priv *priv)
2903 priv->mlme_workqueue = alloc_ordered_workqueue(
2907 if (!priv->mlme_workqueue) {
2908 dev_crit(&priv->spi->dev, "alloc of mlme_workqueue failed!\n");
2912 priv->irq_workqueue = alloc_ordered_workqueue(
2913 "ca8210 irq worker",
2916 if (!priv->irq_workqueue) {
2917 dev_crit(&priv->spi->dev, "alloc of irq_workqueue failed!\n");
2918 destroy_workqueue(priv->mlme_workqueue);
2926 * ca8210_dev_com_clear() - Deinitialise the spi communication component
2927 * @priv: Pointer to private data structure
2929 static void ca8210_dev_com_clear(struct ca8210_priv *priv)
2931 flush_workqueue(priv->mlme_workqueue);
2932 destroy_workqueue(priv->mlme_workqueue);
2933 flush_workqueue(priv->irq_workqueue);
2934 destroy_workqueue(priv->irq_workqueue);
2937 #define CA8210_MAX_TX_POWERS (9)
2938 static const s32 ca8210_tx_powers[CA8210_MAX_TX_POWERS] = {
2939 800, 700, 600, 500, 400, 300, 200, 100, 0
2942 #define CA8210_MAX_ED_LEVELS (21)
2943 static const s32 ca8210_ed_levels[CA8210_MAX_ED_LEVELS] = {
2944 -10300, -10250, -10200, -10150, -10100, -10050, -10000, -9950, -9900,
2945 -9850, -9800, -9750, -9700, -9650, -9600, -9550, -9500, -9450, -9400,
2950 * ca8210_hw_setup() - Populate the ieee802154_hw phy attributes with the
2952 * @ca8210_hw: Pointer to ieee802154_hw to populate
2954 static void ca8210_hw_setup(struct ieee802154_hw *ca8210_hw)
2956 /* Support channels 11-26 */
2957 ca8210_hw->phy->supported.channels[0] = CA8210_VALID_CHANNELS;
2958 ca8210_hw->phy->supported.tx_powers_size = CA8210_MAX_TX_POWERS;
2959 ca8210_hw->phy->supported.tx_powers = ca8210_tx_powers;
2960 ca8210_hw->phy->supported.cca_ed_levels_size = CA8210_MAX_ED_LEVELS;
2961 ca8210_hw->phy->supported.cca_ed_levels = ca8210_ed_levels;
2962 ca8210_hw->phy->current_channel = 18;
2963 ca8210_hw->phy->current_page = 0;
2964 ca8210_hw->phy->transmit_power = 800;
2965 ca8210_hw->phy->cca.mode = NL802154_CCA_ENERGY_CARRIER;
2966 ca8210_hw->phy->cca.opt = NL802154_CCA_OPT_ENERGY_CARRIER_AND;
2967 ca8210_hw->phy->cca_ed_level = -9800;
2968 ca8210_hw->phy->symbol_duration = 16;
2969 ca8210_hw->phy->lifs_period = 40 * ca8210_hw->phy->symbol_duration;
2970 ca8210_hw->phy->sifs_period = 12 * ca8210_hw->phy->symbol_duration;
2972 IEEE802154_HW_AFILT |
2973 IEEE802154_HW_OMIT_CKSUM |
2974 IEEE802154_HW_FRAME_RETRIES |
2975 IEEE802154_HW_PROMISCUOUS |
2976 IEEE802154_HW_CSMA_PARAMS;
2977 ca8210_hw->phy->flags =
2978 WPAN_PHY_FLAG_TXPOWER |
2979 WPAN_PHY_FLAG_CCA_ED_LEVEL |
2980 WPAN_PHY_FLAG_CCA_MODE;
2984 * ca8210_test_interface_init() - Initialise the test file interface
2985 * @priv: Pointer to private data structure
2987 * Provided as an alternative to the standard linux network interface, the test
2988 * interface exposes a file in the filesystem (ca8210_test) that allows
2989 * 802.15.4 SAP Commands and Cascoda EVBME commands to be sent directly to
2992 * Return: 0 or linux error code
2994 static int ca8210_test_interface_init(struct ca8210_priv *priv)
2996 struct ca8210_test *test = &priv->test;
3003 priv->spi->master->bus_num,
3004 priv->spi->chip_select
3007 test->ca8210_dfs_spi_int = debugfs_create_file(
3009 0600, /* S_IRUSR | S_IWUSR */
3014 if (IS_ERR(test->ca8210_dfs_spi_int)) {
3017 "Error %ld when creating debugfs node\n",
3018 PTR_ERR(test->ca8210_dfs_spi_int)
3020 return PTR_ERR(test->ca8210_dfs_spi_int);
3022 debugfs_create_symlink("ca8210", NULL, node_name);
3023 init_waitqueue_head(&test->readq);
3026 CA8210_TEST_INT_FIFO_SIZE,
3032 * ca8210_test_interface_clear() - Deinitialise the test file interface
3033 * @priv: Pointer to private data structure
3035 static void ca8210_test_interface_clear(struct ca8210_priv *priv)
3037 struct ca8210_test *test = &priv->test;
3039 if (!IS_ERR(test->ca8210_dfs_spi_int))
3040 debugfs_remove(test->ca8210_dfs_spi_int);
3041 kfifo_free(&test->up_fifo);
3042 dev_info(&priv->spi->dev, "Test interface removed\n");
3046 * ca8210_remove() - Shut down a ca8210 upon being disconnected
3047 * @priv: Pointer to private data structure
3049 * Return: 0 or linux error code
3051 static int ca8210_remove(struct spi_device *spi_device)
3053 struct ca8210_priv *priv;
3054 struct ca8210_platform_data *pdata;
3056 dev_info(&spi_device->dev, "Removing ca8210\n");
3058 pdata = spi_device->dev.platform_data;
3060 if (pdata->extclockenable) {
3061 ca8210_unregister_ext_clock(spi_device);
3062 ca8210_config_extern_clk(pdata, spi_device, 0);
3064 free_irq(pdata->irq_id, spi_device->dev.driver_data);
3066 spi_device->dev.platform_data = NULL;
3068 /* get spi_device private data */
3069 priv = spi_get_drvdata(spi_device);
3073 "sync_down = %d, sync_up = %d\n",
3077 ca8210_dev_com_clear(spi_device->dev.driver_data);
3079 if (priv->hw_registered)
3080 ieee802154_unregister_hw(priv->hw);
3081 ieee802154_free_hw(priv->hw);
3085 "Unregistered & freed ieee802154_hw.\n"
3088 if (IS_ENABLED(CONFIG_IEEE802154_CA8210_DEBUGFS))
3089 ca8210_test_interface_clear(priv);
3096 * ca8210_probe() - Set up a connected ca8210 upon being detected by the system
3097 * @priv: Pointer to private data structure
3099 * Return: 0 or linux error code
3101 static int ca8210_probe(struct spi_device *spi_device)
3103 struct ca8210_priv *priv;
3104 struct ieee802154_hw *hw;
3105 struct ca8210_platform_data *pdata;
3108 dev_info(&spi_device->dev, "Inserting ca8210\n");
3110 /* allocate ieee802154_hw and private data */
3111 hw = ieee802154_alloc_hw(sizeof(struct ca8210_priv), &ca8210_phy_ops);
3113 dev_crit(&spi_device->dev, "ieee802154_alloc_hw failed\n");
3120 priv->spi = spi_device;
3121 hw->parent = &spi_device->dev;
3122 spin_lock_init(&priv->lock);
3123 priv->async_tx_pending = false;
3124 priv->hw_registered = false;
3126 priv->sync_down = 0;
3127 priv->promiscuous = false;
3129 init_completion(&priv->ca8210_is_awake);
3130 init_completion(&priv->spi_transfer_complete);
3131 init_completion(&priv->sync_exchange_complete);
3132 spi_set_drvdata(priv->spi, priv);
3133 if (IS_ENABLED(CONFIG_IEEE802154_CA8210_DEBUGFS)) {
3134 cascoda_api_upstream = ca8210_test_int_driver_write;
3135 ca8210_test_interface_init(priv);
3137 cascoda_api_upstream = NULL;
3139 ca8210_hw_setup(hw);
3140 ieee802154_random_extended_addr(&hw->phy->perm_extended_addr);
3142 pdata = kmalloc(sizeof(*pdata), GFP_KERNEL);
3148 priv->spi->dev.platform_data = pdata;
3149 ret = ca8210_get_platform_data(priv->spi, pdata);
3151 dev_crit(&spi_device->dev, "ca8210_get_platform_data failed\n");
3155 ret = ca8210_dev_com_init(priv);
3157 dev_crit(&spi_device->dev, "ca8210_dev_com_init failed\n");
3160 ret = ca8210_reset_init(priv->spi);
3162 dev_crit(&spi_device->dev, "ca8210_reset_init failed\n");
3166 ret = ca8210_interrupt_init(priv->spi);
3168 dev_crit(&spi_device->dev, "ca8210_interrupt_init failed\n");
3174 ca8210_reset_send(priv->spi, 1);
3176 ret = tdme_chipinit(priv->spi);
3178 dev_crit(&spi_device->dev, "tdme_chipinit failed\n");
3182 if (pdata->extclockenable) {
3183 ret = ca8210_config_extern_clk(pdata, priv->spi, 1);
3187 "ca8210_config_extern_clk failed\n"
3191 ret = ca8210_register_ext_clock(priv->spi);
3195 "ca8210_register_ext_clock failed\n"
3201 ret = ieee802154_register_hw(hw);
3203 dev_crit(&spi_device->dev, "ieee802154_register_hw failed\n");
3206 priv->hw_registered = true;
3210 msleep(100); /* wait for pending spi transfers to complete */
3211 ca8210_remove(spi_device);
3212 return link_to_linux_err(ret);
3215 static const struct of_device_id ca8210_of_ids[] = {
3216 {.compatible = "cascoda,ca8210", },
3219 MODULE_DEVICE_TABLE(of, ca8210_of_ids);
3221 static struct spi_driver ca8210_spi_driver = {
3223 .name = DRIVER_NAME,
3224 .owner = THIS_MODULE,
3225 .of_match_table = of_match_ptr(ca8210_of_ids),
3227 .probe = ca8210_probe,
3228 .remove = ca8210_remove
3231 module_spi_driver(ca8210_spi_driver);
3233 MODULE_AUTHOR("Harry Morris <h.morris@cascoda.com>");
3234 MODULE_DESCRIPTION("CA-8210 SoftMAC driver");
3235 MODULE_LICENSE("Dual BSD/GPL");
3236 MODULE_VERSION("1.0");