blob: 0a46348f9af67f945f527e97009bc78974ffc663 [file] [log] [blame]
Mark A. Greer165063f2014-03-10 11:56:22 -07001/*
2 * TI TRF7970a RFID/NFC Transceiver Driver
3 *
4 * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com
5 *
6 * Author: Erick Macias <emacias@ti.com>
7 * Author: Felipe Balbi <balbi@ti.com>
8 * Author: Mark A. Greer <mgreer@animalcreek.com>
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 of
12 * the License as published by the Free Software Foundation.
13 */
14
15#include <linux/module.h>
16#include <linux/device.h>
17#include <linux/netdevice.h>
18#include <linux/interrupt.h>
19#include <linux/nfc.h>
20#include <linux/skbuff.h>
21#include <linux/delay.h>
22#include <linux/gpio.h>
23#include <linux/of.h>
24#include <linux/of_gpio.h>
25#include <linux/spi/spi.h>
26#include <linux/regulator/consumer.h>
27
28#include <net/nfc/nfc.h>
29#include <net/nfc/digital.h>
30
31/* There are 3 ways the host can communicate with the trf7970a:
32 * parallel mode, SPI with Slave Select (SS) mode, and SPI without
33 * SS mode. The driver only supports the two SPI modes.
34 *
35 * The trf7970a is very timing sensitive and the VIN, EN2, and EN
36 * pins must asserted in that order and with specific delays in between.
37 * The delays used in the driver were provided by TI and have been
38 * confirmed to work with this driver.
39 *
40 * Timeouts are implemented using the delayed workqueue kernel facility.
41 * Timeouts are required so things don't hang when there is no response
42 * from the trf7970a (or tag). Using this mechanism creates a race with
43 * interrupts, however. That is, an interrupt and a timeout could occur
44 * closely enough together that one is blocked by the mutex while the other
45 * executes. When the timeout handler executes first and blocks the
46 * interrupt handler, it will eventually set the state to IDLE so the
47 * interrupt handler will check the state and exit with no harm done.
48 * When the interrupt handler executes first and blocks the timeout handler,
49 * the cancel_delayed_work() call will know that it didn't cancel the
50 * work item (i.e., timeout) and will return zero. That return code is
51 * used by the timer handler to indicate that it should ignore the timeout
52 * once its unblocked.
53 *
54 * Aborting an active command isn't as simple as it seems because the only
55 * way to abort a command that's already been sent to the tag is so turn
56 * off power to the tag. If we do that, though, we'd have to go through
57 * the entire anticollision procedure again but the digital layer doesn't
58 * support that. So, if an abort is received before trf7970a_in_send_cmd()
59 * has sent the command to the tag, it simply returns -ECANCELED. If the
60 * command has already been sent to the tag, then the driver continues
61 * normally and recieves the response data (or error) but just before
62 * sending the data upstream, it frees the rx_skb and sends -ECANCELED
63 * upstream instead. If the command failed, that error will be sent
64 * upstream.
65 *
66 * When recieving data from a tag and the interrupt status register has
67 * only the SRX bit set, it means that all of the data has been received
68 * (once what's in the fifo has been read). However, depending on timing
69 * an interrupt status with only the SRX bit set may not be recived. In
Mark A. Greer5fa3af32014-03-25 08:54:29 -070070 * those cases, the timeout mechanism is used to wait 20 ms in case more
71 * data arrives. After 20 ms, it is assumed that all of the data has been
Mark A. Greer165063f2014-03-10 11:56:22 -070072 * received and the accumulated rx data is sent upstream. The
73 * 'TRF7970A_ST_WAIT_FOR_RX_DATA_CONT' state is used for this purpose
74 * (i.e., it indicates that some data has been received but we're not sure
75 * if there is more coming so a timeout in this state means all data has
Mark A. Greer5fa3af32014-03-25 08:54:29 -070076 * been received and there isn't an error). The delay is 20 ms since delays
77 * of ~16 ms have been observed during testing.
Mark A. Greer165063f2014-03-10 11:56:22 -070078 *
79 * Type 2 write and sector select commands respond with a 4-bit ACK or NACK.
80 * Having only 4 bits in the FIFO won't normally generate an interrupt so
81 * driver enables the '4_bit_RX' bit of the Special Functions register 1
82 * to cause an interrupt in that case. Leaving that bit for a read command
83 * messes up the data returned so it is only enabled when the framing is
84 * 'NFC_DIGITAL_FRAMING_NFCA_T2T' and the command is not a read command.
85 * Unfortunately, that means that the driver has to peek into tx frames
86 * when the framing is 'NFC_DIGITAL_FRAMING_NFCA_T2T'. This is done by
87 * the trf7970a_per_cmd_config() routine.
Mark A. Greer9d9304b2014-03-10 11:56:24 -070088 *
89 * ISO/IEC 15693 frames specify whether to use single or double sub-carrier
90 * frequencies and whether to use low or high data rates in the flags byte
91 * of the frame. This means that the driver has to peek at all 15693 frames
92 * to determine what speed to set the communication to. In addition, write
93 * and lock commands use the OPTION flag to indicate that an EOF must be
94 * sent to the tag before it will send its response. So the driver has to
95 * examine all frames for that reason too.
96 *
97 * It is unclear how long to wait before sending the EOF. According to the
98 * Note under Table 1-1 in section 1.6 of
99 * http://www.ti.com/lit/ug/scbu011/scbu011.pdf, that wait should be at least
100 * 10 ms for TI Tag-it HF-I tags; however testing has shown that is not long
101 * enough. For this reason, the driver waits 20 ms which seems to work
102 * reliably.
Mark A. Greer165063f2014-03-10 11:56:22 -0700103 */
104
Mark A. Greer80062892014-03-10 11:56:23 -0700105#define TRF7970A_SUPPORTED_PROTOCOLS \
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700106 (NFC_PROTO_MIFARE_MASK | NFC_PROTO_ISO14443_MASK | \
107 NFC_PROTO_ISO15693_MASK)
Mark A. Greer165063f2014-03-10 11:56:22 -0700108
109/* TX data must be prefixed with a FIFO reset cmd, a cmd that depends
110 * on what the current framing is, the address of the TX length byte 1
111 * register (0x1d), and the 2 byte length of the data to be transmitted.
112 * That totals 5 bytes.
113 */
114#define TRF7970A_TX_SKB_HEADROOM 5
115
116#define TRF7970A_RX_SKB_ALLOC_SIZE 256
117
118#define TRF7970A_FIFO_SIZE 128
119
120/* TX length is 3 nibbles long ==> 4KB - 1 bytes max */
121#define TRF7970A_TX_MAX (4096 - 1)
122
Mark A. Greer5fa3af32014-03-25 08:54:29 -0700123#define TRF7970A_WAIT_FOR_RX_DATA_TIMEOUT 20
Mark A. Greer165063f2014-03-10 11:56:22 -0700124#define TRF7970A_WAIT_FOR_FIFO_DRAIN_TIMEOUT 3
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700125#define TRF7970A_WAIT_TO_ISSUE_ISO15693_EOF 20
Mark A. Greer165063f2014-03-10 11:56:22 -0700126
127/* Quirks */
128/* Erratum: When reading IRQ Status register on trf7970a, we must issue a
129 * read continuous command for IRQ Status and Collision Position registers.
130 */
131#define TRF7970A_QUIRK_IRQ_STATUS_READ_ERRATA BIT(0)
132
133/* Direct commands */
134#define TRF7970A_CMD_IDLE 0x00
135#define TRF7970A_CMD_SOFT_INIT 0x03
136#define TRF7970A_CMD_RF_COLLISION 0x04
137#define TRF7970A_CMD_RF_COLLISION_RESPONSE_N 0x05
138#define TRF7970A_CMD_RF_COLLISION_RESPONSE_0 0x06
139#define TRF7970A_CMD_FIFO_RESET 0x0f
140#define TRF7970A_CMD_TRANSMIT_NO_CRC 0x10
141#define TRF7970A_CMD_TRANSMIT 0x11
142#define TRF7970A_CMD_DELAY_TRANSMIT_NO_CRC 0x12
143#define TRF7970A_CMD_DELAY_TRANSMIT 0x13
144#define TRF7970A_CMD_EOF 0x14
145#define TRF7970A_CMD_CLOSE_SLOT 0x15
146#define TRF7970A_CMD_BLOCK_RX 0x16
147#define TRF7970A_CMD_ENABLE_RX 0x17
148#define TRF7970A_CMD_TEST_EXT_RF 0x18
149#define TRF7970A_CMD_TEST_INT_RF 0x19
150#define TRF7970A_CMD_RX_GAIN_ADJUST 0x1a
151
152/* Bits determining whether its a direct command or register R/W,
153 * whether to use a continuous SPI transaction or not, and the actual
154 * direct cmd opcode or regster address.
155 */
156#define TRF7970A_CMD_BIT_CTRL BIT(7)
157#define TRF7970A_CMD_BIT_RW BIT(6)
158#define TRF7970A_CMD_BIT_CONTINUOUS BIT(5)
159#define TRF7970A_CMD_BIT_OPCODE(opcode) ((opcode) & 0x1f)
160
161/* Registers addresses */
162#define TRF7970A_CHIP_STATUS_CTRL 0x00
163#define TRF7970A_ISO_CTRL 0x01
164#define TRF7970A_ISO14443B_TX_OPTIONS 0x02
165#define TRF7970A_ISO14443A_HIGH_BITRATE_OPTIONS 0x03
166#define TRF7970A_TX_TIMER_SETTING_H_BYTE 0x04
167#define TRF7970A_TX_TIMER_SETTING_L_BYTE 0x05
168#define TRF7970A_TX_PULSE_LENGTH_CTRL 0x06
169#define TRF7970A_RX_NO_RESPONSE_WAIT 0x07
170#define TRF7970A_RX_WAIT_TIME 0x08
171#define TRF7970A_MODULATOR_SYS_CLK_CTRL 0x09
172#define TRF7970A_RX_SPECIAL_SETTINGS 0x0a
173#define TRF7970A_REG_IO_CTRL 0x0b
174#define TRF7970A_IRQ_STATUS 0x0c
175#define TRF7970A_COLLISION_IRQ_MASK 0x0d
176#define TRF7970A_COLLISION_POSITION 0x0e
177#define TRF7970A_RSSI_OSC_STATUS 0x0f
178#define TRF7970A_SPECIAL_FCN_REG1 0x10
179#define TRF7970A_SPECIAL_FCN_REG2 0x11
180#define TRF7970A_RAM1 0x12
181#define TRF7970A_RAM2 0x13
182#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS 0x14
183#define TRF7970A_NFC_LOW_FIELD_LEVEL 0x16
184#define TRF7970A_NFCID1 0x17
185#define TRF7970A_NFC_TARGET_LEVEL 0x18
186#define TRF79070A_NFC_TARGET_PROTOCOL 0x19
187#define TRF7970A_TEST_REGISTER1 0x1a
188#define TRF7970A_TEST_REGISTER2 0x1b
189#define TRF7970A_FIFO_STATUS 0x1c
190#define TRF7970A_TX_LENGTH_BYTE1 0x1d
191#define TRF7970A_TX_LENGTH_BYTE2 0x1e
192#define TRF7970A_FIFO_IO_REGISTER 0x1f
193
194/* Chip Status Control Register Bits */
195#define TRF7970A_CHIP_STATUS_VRS5_3 BIT(0)
196#define TRF7970A_CHIP_STATUS_REC_ON BIT(1)
197#define TRF7970A_CHIP_STATUS_AGC_ON BIT(2)
198#define TRF7970A_CHIP_STATUS_PM_ON BIT(3)
199#define TRF7970A_CHIP_STATUS_RF_PWR BIT(4)
200#define TRF7970A_CHIP_STATUS_RF_ON BIT(5)
201#define TRF7970A_CHIP_STATUS_DIRECT BIT(6)
202#define TRF7970A_CHIP_STATUS_STBY BIT(7)
203
204/* ISO Control Register Bits */
205#define TRF7970A_ISO_CTRL_15693_SGL_1OF4_662 0x00
206#define TRF7970A_ISO_CTRL_15693_SGL_1OF256_662 0x01
207#define TRF7970A_ISO_CTRL_15693_SGL_1OF4_2648 0x02
208#define TRF7970A_ISO_CTRL_15693_SGL_1OF256_2648 0x03
209#define TRF7970A_ISO_CTRL_15693_DBL_1OF4_667a 0x04
210#define TRF7970A_ISO_CTRL_15693_DBL_1OF256_667 0x05
211#define TRF7970A_ISO_CTRL_15693_DBL_1OF4_2669 0x06
212#define TRF7970A_ISO_CTRL_15693_DBL_1OF256_2669 0x07
213#define TRF7970A_ISO_CTRL_14443A_106 0x08
214#define TRF7970A_ISO_CTRL_14443A_212 0x09
215#define TRF7970A_ISO_CTRL_14443A_424 0x0a
216#define TRF7970A_ISO_CTRL_14443A_848 0x0b
217#define TRF7970A_ISO_CTRL_14443B_106 0x0c
218#define TRF7970A_ISO_CTRL_14443B_212 0x0d
219#define TRF7970A_ISO_CTRL_14443B_424 0x0e
220#define TRF7970A_ISO_CTRL_14443B_848 0x0f
221#define TRF7970A_ISO_CTRL_FELICA_212 0x1a
222#define TRF7970A_ISO_CTRL_FELICA_424 0x1b
223#define TRF7970A_ISO_CTRL_RFID BIT(5)
224#define TRF7970A_ISO_CTRL_DIR_MODE BIT(6)
225#define TRF7970A_ISO_CTRL_RX_CRC_N BIT(7) /* true == No CRC */
226
227#define TRF7970A_ISO_CTRL_RFID_SPEED_MASK 0x1f
228
229/* Modulator and SYS_CLK Control Register Bits */
230#define TRF7970A_MODULATOR_DEPTH(n) ((n) & 0x7)
231#define TRF7970A_MODULATOR_DEPTH_ASK10 (TRF7970A_MODULATOR_DEPTH(0))
232#define TRF7970A_MODULATOR_DEPTH_OOK (TRF7970A_MODULATOR_DEPTH(1))
233#define TRF7970A_MODULATOR_DEPTH_ASK7 (TRF7970A_MODULATOR_DEPTH(2))
234#define TRF7970A_MODULATOR_DEPTH_ASK8_5 (TRF7970A_MODULATOR_DEPTH(3))
235#define TRF7970A_MODULATOR_DEPTH_ASK13 (TRF7970A_MODULATOR_DEPTH(4))
236#define TRF7970A_MODULATOR_DEPTH_ASK16 (TRF7970A_MODULATOR_DEPTH(5))
237#define TRF7970A_MODULATOR_DEPTH_ASK22 (TRF7970A_MODULATOR_DEPTH(6))
238#define TRF7970A_MODULATOR_DEPTH_ASK30 (TRF7970A_MODULATOR_DEPTH(7))
239#define TRF7970A_MODULATOR_EN_ANA BIT(3)
240#define TRF7970A_MODULATOR_CLK(n) (((n) & 0x3) << 4)
241#define TRF7970A_MODULATOR_CLK_DISABLED (TRF7970A_MODULATOR_CLK(0))
242#define TRF7970A_MODULATOR_CLK_3_6 (TRF7970A_MODULATOR_CLK(1))
243#define TRF7970A_MODULATOR_CLK_6_13 (TRF7970A_MODULATOR_CLK(2))
244#define TRF7970A_MODULATOR_CLK_13_27 (TRF7970A_MODULATOR_CLK(3))
245#define TRF7970A_MODULATOR_EN_OOK BIT(6)
246#define TRF7970A_MODULATOR_27MHZ BIT(7)
247
248/* IRQ Status Register Bits */
249#define TRF7970A_IRQ_STATUS_NORESP BIT(0) /* ISO15693 only */
250#define TRF7970A_IRQ_STATUS_COL BIT(1)
251#define TRF7970A_IRQ_STATUS_FRAMING_EOF_ERROR BIT(2)
252#define TRF7970A_IRQ_STATUS_PARITY_ERROR BIT(3)
253#define TRF7970A_IRQ_STATUS_CRC_ERROR BIT(4)
254#define TRF7970A_IRQ_STATUS_FIFO BIT(5)
255#define TRF7970A_IRQ_STATUS_SRX BIT(6)
256#define TRF7970A_IRQ_STATUS_TX BIT(7)
257
258#define TRF7970A_IRQ_STATUS_ERROR \
259 (TRF7970A_IRQ_STATUS_COL | \
260 TRF7970A_IRQ_STATUS_FRAMING_EOF_ERROR | \
261 TRF7970A_IRQ_STATUS_PARITY_ERROR | \
262 TRF7970A_IRQ_STATUS_CRC_ERROR)
263
264#define TRF7970A_SPECIAL_FCN_REG1_COL_7_6 BIT(0)
265#define TRF7970A_SPECIAL_FCN_REG1_14_ANTICOLL BIT(1)
266#define TRF7970A_SPECIAL_FCN_REG1_4_BIT_RX BIT(2)
267#define TRF7970A_SPECIAL_FCN_REG1_SP_DIR_MODE BIT(3)
268#define TRF7970A_SPECIAL_FCN_REG1_NEXT_SLOT_37US BIT(4)
269#define TRF7970A_SPECIAL_FCN_REG1_PAR43 BIT(5)
270
271#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLH_124 (0x0 << 2)
272#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLH_120 (0x1 << 2)
273#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLH_112 (0x2 << 2)
274#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLH_96 (0x3 << 2)
275#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLL_4 0x0
276#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLL_8 0x1
277#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLL_16 0x2
278#define TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLL_32 0x3
279
280#define TRF7970A_FIFO_STATUS_OVERFLOW BIT(7)
281
282/* NFC (ISO/IEC 14443A) Type 2 Tag commands */
283#define NFC_T2T_CMD_READ 0x30
284
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700285/* ISO 15693 commands codes */
286#define ISO15693_CMD_INVENTORY 0x01
287#define ISO15693_CMD_READ_SINGLE_BLOCK 0x20
288#define ISO15693_CMD_WRITE_SINGLE_BLOCK 0x21
289#define ISO15693_CMD_LOCK_BLOCK 0x22
290#define ISO15693_CMD_READ_MULTIPLE_BLOCK 0x23
291#define ISO15693_CMD_WRITE_MULTIPLE_BLOCK 0x24
292#define ISO15693_CMD_SELECT 0x25
293#define ISO15693_CMD_RESET_TO_READY 0x26
294#define ISO15693_CMD_WRITE_AFI 0x27
295#define ISO15693_CMD_LOCK_AFI 0x28
296#define ISO15693_CMD_WRITE_DSFID 0x29
297#define ISO15693_CMD_LOCK_DSFID 0x2a
298#define ISO15693_CMD_GET_SYSTEM_INFO 0x2b
299#define ISO15693_CMD_GET_MULTIPLE_BLOCK_SECURITY_STATUS 0x2c
300
301/* ISO 15693 request and response flags */
302#define ISO15693_REQ_FLAG_SUB_CARRIER BIT(0)
303#define ISO15693_REQ_FLAG_DATA_RATE BIT(1)
304#define ISO15693_REQ_FLAG_INVENTORY BIT(2)
305#define ISO15693_REQ_FLAG_PROTOCOL_EXT BIT(3)
306#define ISO15693_REQ_FLAG_SELECT BIT(4)
307#define ISO15693_REQ_FLAG_AFI BIT(4)
308#define ISO15693_REQ_FLAG_ADDRESS BIT(5)
309#define ISO15693_REQ_FLAG_NB_SLOTS BIT(5)
310#define ISO15693_REQ_FLAG_OPTION BIT(6)
311
312#define ISO15693_REQ_FLAG_SPEED_MASK \
313 (ISO15693_REQ_FLAG_SUB_CARRIER | ISO15693_REQ_FLAG_DATA_RATE)
314
Mark A. Greer165063f2014-03-10 11:56:22 -0700315enum trf7970a_state {
316 TRF7970A_ST_OFF,
317 TRF7970A_ST_IDLE,
318 TRF7970A_ST_IDLE_RX_BLOCKED,
319 TRF7970A_ST_WAIT_FOR_TX_FIFO,
320 TRF7970A_ST_WAIT_FOR_RX_DATA,
321 TRF7970A_ST_WAIT_FOR_RX_DATA_CONT,
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700322 TRF7970A_ST_WAIT_TO_ISSUE_EOF,
Mark A. Greer165063f2014-03-10 11:56:22 -0700323 TRF7970A_ST_MAX
324};
325
326struct trf7970a {
327 enum trf7970a_state state;
328 struct device *dev;
329 struct spi_device *spi;
330 struct regulator *regulator;
331 struct nfc_digital_dev *ddev;
332 u32 quirks;
333 bool powering_up;
334 bool aborting;
335 struct sk_buff *tx_skb;
336 struct sk_buff *rx_skb;
337 nfc_digital_cmd_complete_t cb;
338 void *cb_arg;
Mark A. Greerebcc5a02014-03-25 08:54:36 -0700339 u8 chip_status_ctrl;
Mark A. Greer165063f2014-03-10 11:56:22 -0700340 u8 iso_ctrl;
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700341 u8 iso_ctrl_tech;
Mark A. Greer12e9ade2014-03-25 08:54:35 -0700342 u8 modulator_sys_clk_ctrl;
Mark A. Greer165063f2014-03-10 11:56:22 -0700343 u8 special_fcn_reg1;
344 int technology;
345 int framing;
346 u8 tx_cmd;
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700347 bool issue_eof;
Mark A. Greer165063f2014-03-10 11:56:22 -0700348 int en2_gpio;
349 int en_gpio;
350 struct mutex lock;
351 unsigned int timeout;
352 bool ignore_timeout;
353 struct delayed_work timeout_work;
354};
355
356
357static int trf7970a_cmd(struct trf7970a *trf, u8 opcode)
358{
359 u8 cmd = TRF7970A_CMD_BIT_CTRL | TRF7970A_CMD_BIT_OPCODE(opcode);
360 int ret;
361
362 dev_dbg(trf->dev, "cmd: 0x%x\n", cmd);
363
364 ret = spi_write(trf->spi, &cmd, 1);
365 if (ret)
366 dev_err(trf->dev, "%s - cmd: 0x%x, ret: %d\n", __func__, cmd,
367 ret);
368 return ret;
369}
370
371static int trf7970a_read(struct trf7970a *trf, u8 reg, u8 *val)
372{
373 u8 addr = TRF7970A_CMD_BIT_RW | reg;
374 int ret;
375
376 ret = spi_write_then_read(trf->spi, &addr, 1, val, 1);
377 if (ret)
378 dev_err(trf->dev, "%s - addr: 0x%x, ret: %d\n", __func__, addr,
379 ret);
380
381 dev_dbg(trf->dev, "read(0x%x): 0x%x\n", addr, *val);
382
383 return ret;
384}
385
386static int trf7970a_read_cont(struct trf7970a *trf, u8 reg,
387 u8 *buf, size_t len)
388{
389 u8 addr = reg | TRF7970A_CMD_BIT_RW | TRF7970A_CMD_BIT_CONTINUOUS;
390 int ret;
391
392 dev_dbg(trf->dev, "read_cont(0x%x, %zd)\n", addr, len);
393
394 ret = spi_write_then_read(trf->spi, &addr, 1, buf, len);
395 if (ret)
396 dev_err(trf->dev, "%s - addr: 0x%x, ret: %d\n", __func__, addr,
397 ret);
398 return ret;
399}
400
401static int trf7970a_write(struct trf7970a *trf, u8 reg, u8 val)
402{
403 u8 buf[2] = { reg, val };
404 int ret;
405
406 dev_dbg(trf->dev, "write(0x%x): 0x%x\n", reg, val);
407
408 ret = spi_write(trf->spi, buf, 2);
409 if (ret)
410 dev_err(trf->dev, "%s - write: 0x%x 0x%x, ret: %d\n", __func__,
411 buf[0], buf[1], ret);
412
413 return ret;
414}
415
416static int trf7970a_read_irqstatus(struct trf7970a *trf, u8 *status)
417{
418 int ret;
419 u8 buf[2];
420 u8 addr;
421
422 addr = TRF7970A_IRQ_STATUS | TRF7970A_CMD_BIT_RW;
423
424 if (trf->quirks & TRF7970A_QUIRK_IRQ_STATUS_READ_ERRATA) {
425 addr |= TRF7970A_CMD_BIT_CONTINUOUS;
426 ret = spi_write_then_read(trf->spi, &addr, 1, buf, 2);
427 } else {
428 ret = spi_write_then_read(trf->spi, &addr, 1, buf, 1);
429 }
430
431 if (ret)
432 dev_err(trf->dev, "%s - irqstatus: Status read failed: %d\n",
433 __func__, ret);
434 else
435 *status = buf[0];
436
437 return ret;
438}
439
440static void trf7970a_send_upstream(struct trf7970a *trf)
441{
442 u8 rssi;
443
444 dev_kfree_skb_any(trf->tx_skb);
445 trf->tx_skb = NULL;
446
447 if (trf->rx_skb && !IS_ERR(trf->rx_skb) && !trf->aborting)
448 print_hex_dump_debug("trf7970a rx data: ", DUMP_PREFIX_NONE,
449 16, 1, trf->rx_skb->data, trf->rx_skb->len,
450 false);
451
452 /* According to the manual it is "good form" to reset the fifo and
453 * read the RSSI levels & oscillator status register here. It doesn't
454 * explain why.
455 */
456 trf7970a_cmd(trf, TRF7970A_CMD_FIFO_RESET);
457 trf7970a_read(trf, TRF7970A_RSSI_OSC_STATUS, &rssi);
458
459 trf->state = TRF7970A_ST_IDLE;
460
461 if (trf->aborting) {
462 dev_dbg(trf->dev, "Abort process complete\n");
463
464 if (!IS_ERR(trf->rx_skb)) {
465 kfree_skb(trf->rx_skb);
466 trf->rx_skb = ERR_PTR(-ECANCELED);
467 }
468
469 trf->aborting = false;
470 }
471
472 trf->cb(trf->ddev, trf->cb_arg, trf->rx_skb);
473
474 trf->rx_skb = NULL;
475}
476
477static void trf7970a_send_err_upstream(struct trf7970a *trf, int errno)
478{
479 dev_dbg(trf->dev, "Error - state: %d, errno: %d\n", trf->state, errno);
480
481 kfree_skb(trf->rx_skb);
482 trf->rx_skb = ERR_PTR(errno);
483
484 trf7970a_send_upstream(trf);
485}
486
487static int trf7970a_transmit(struct trf7970a *trf, struct sk_buff *skb,
488 unsigned int len)
489{
490 unsigned int timeout;
491 int ret;
492
493 print_hex_dump_debug("trf7970a tx data: ", DUMP_PREFIX_NONE,
494 16, 1, skb->data, len, false);
495
496 ret = spi_write(trf->spi, skb->data, len);
497 if (ret) {
498 dev_err(trf->dev, "%s - Can't send tx data: %d\n", __func__,
499 ret);
500 return ret;
501 }
502
503 skb_pull(skb, len);
504
505 if (skb->len > 0) {
506 trf->state = TRF7970A_ST_WAIT_FOR_TX_FIFO;
507 timeout = TRF7970A_WAIT_FOR_FIFO_DRAIN_TIMEOUT;
508 } else {
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700509 if (trf->issue_eof) {
510 trf->state = TRF7970A_ST_WAIT_TO_ISSUE_EOF;
511 timeout = TRF7970A_WAIT_TO_ISSUE_ISO15693_EOF;
512 } else {
513 trf->state = TRF7970A_ST_WAIT_FOR_RX_DATA;
514 timeout = trf->timeout;
515 }
Mark A. Greer165063f2014-03-10 11:56:22 -0700516 }
517
518 dev_dbg(trf->dev, "Setting timeout for %d ms, state: %d\n", timeout,
519 trf->state);
520
521 schedule_delayed_work(&trf->timeout_work, msecs_to_jiffies(timeout));
522
523 return 0;
524}
525
526static void trf7970a_fill_fifo(struct trf7970a *trf)
527{
528 struct sk_buff *skb = trf->tx_skb;
529 unsigned int len;
530 int ret;
531 u8 fifo_bytes;
532
533 ret = trf7970a_read(trf, TRF7970A_FIFO_STATUS, &fifo_bytes);
534 if (ret) {
535 trf7970a_send_err_upstream(trf, ret);
536 return;
537 }
538
539 dev_dbg(trf->dev, "Filling FIFO - fifo_bytes: 0x%x\n", fifo_bytes);
540
541 if (fifo_bytes & TRF7970A_FIFO_STATUS_OVERFLOW) {
542 dev_err(trf->dev, "%s - fifo overflow: 0x%x\n", __func__,
543 fifo_bytes);
544 trf7970a_send_err_upstream(trf, -EIO);
545 return;
546 }
547
548 /* Calculate how much more data can be written to the fifo */
549 len = TRF7970A_FIFO_SIZE - fifo_bytes;
550 len = min(skb->len, len);
551
552 ret = trf7970a_transmit(trf, skb, len);
553 if (ret)
554 trf7970a_send_err_upstream(trf, ret);
555}
556
557static void trf7970a_drain_fifo(struct trf7970a *trf, u8 status)
558{
559 struct sk_buff *skb = trf->rx_skb;
560 int ret;
561 u8 fifo_bytes;
562
563 if (status & TRF7970A_IRQ_STATUS_ERROR) {
564 trf7970a_send_err_upstream(trf, -EIO);
565 return;
566 }
567
568 ret = trf7970a_read(trf, TRF7970A_FIFO_STATUS, &fifo_bytes);
569 if (ret) {
570 trf7970a_send_err_upstream(trf, ret);
571 return;
572 }
573
574 dev_dbg(trf->dev, "Draining FIFO - fifo_bytes: 0x%x\n", fifo_bytes);
575
576 if (!fifo_bytes)
577 goto no_rx_data;
578
579 if (fifo_bytes & TRF7970A_FIFO_STATUS_OVERFLOW) {
580 dev_err(trf->dev, "%s - fifo overflow: 0x%x\n", __func__,
581 fifo_bytes);
582 trf7970a_send_err_upstream(trf, -EIO);
583 return;
584 }
585
586 if (fifo_bytes > skb_tailroom(skb)) {
587 skb = skb_copy_expand(skb, skb_headroom(skb),
588 max_t(int, fifo_bytes,
589 TRF7970A_RX_SKB_ALLOC_SIZE),
590 GFP_KERNEL);
591 if (!skb) {
592 trf7970a_send_err_upstream(trf, -ENOMEM);
593 return;
594 }
595
596 kfree_skb(trf->rx_skb);
597 trf->rx_skb = skb;
598 }
599
600 ret = trf7970a_read_cont(trf, TRF7970A_FIFO_IO_REGISTER,
601 skb_put(skb, fifo_bytes), fifo_bytes);
602 if (ret) {
603 trf7970a_send_err_upstream(trf, ret);
604 return;
605 }
606
607 /* If received Type 2 ACK/NACK, shift right 4 bits and pass up */
608 if ((trf->framing == NFC_DIGITAL_FRAMING_NFCA_T2T) && (skb->len == 1) &&
609 (trf->special_fcn_reg1 ==
610 TRF7970A_SPECIAL_FCN_REG1_4_BIT_RX)) {
611 skb->data[0] >>= 4;
612 status = TRF7970A_IRQ_STATUS_SRX;
613 } else {
614 trf->state = TRF7970A_ST_WAIT_FOR_RX_DATA_CONT;
615 }
616
617no_rx_data:
618 if (status == TRF7970A_IRQ_STATUS_SRX) { /* Receive complete */
619 trf7970a_send_upstream(trf);
620 return;
621 }
622
623 dev_dbg(trf->dev, "Setting timeout for %d ms\n",
624 TRF7970A_WAIT_FOR_RX_DATA_TIMEOUT);
625
626 schedule_delayed_work(&trf->timeout_work,
627 msecs_to_jiffies(TRF7970A_WAIT_FOR_RX_DATA_TIMEOUT));
628}
629
630static irqreturn_t trf7970a_irq(int irq, void *dev_id)
631{
632 struct trf7970a *trf = dev_id;
633 int ret;
634 u8 status;
635
636 mutex_lock(&trf->lock);
637
638 if (trf->state == TRF7970A_ST_OFF) {
639 mutex_unlock(&trf->lock);
640 return IRQ_NONE;
641 }
642
643 ret = trf7970a_read_irqstatus(trf, &status);
644 if (ret) {
645 mutex_unlock(&trf->lock);
646 return IRQ_NONE;
647 }
648
649 dev_dbg(trf->dev, "IRQ - state: %d, status: 0x%x\n", trf->state,
650 status);
651
652 if (!status) {
653 mutex_unlock(&trf->lock);
654 return IRQ_NONE;
655 }
656
657 switch (trf->state) {
658 case TRF7970A_ST_IDLE:
659 case TRF7970A_ST_IDLE_RX_BLOCKED:
660 /* If getting interrupts caused by RF noise, turn off the
661 * receiver to avoid unnecessary interrupts. It will be
662 * turned back on in trf7970a_in_send_cmd() when the next
663 * command is issued.
664 */
665 if (status & TRF7970A_IRQ_STATUS_ERROR) {
666 trf7970a_cmd(trf, TRF7970A_CMD_BLOCK_RX);
667 trf->state = TRF7970A_ST_IDLE_RX_BLOCKED;
668 }
669
670 trf7970a_cmd(trf, TRF7970A_CMD_FIFO_RESET);
671 break;
672 case TRF7970A_ST_WAIT_FOR_TX_FIFO:
673 if (status & TRF7970A_IRQ_STATUS_TX) {
674 trf->ignore_timeout =
675 !cancel_delayed_work(&trf->timeout_work);
676 trf7970a_fill_fifo(trf);
677 } else {
678 trf7970a_send_err_upstream(trf, -EIO);
679 }
680 break;
681 case TRF7970A_ST_WAIT_FOR_RX_DATA:
682 case TRF7970A_ST_WAIT_FOR_RX_DATA_CONT:
683 if (status & TRF7970A_IRQ_STATUS_SRX) {
684 trf->ignore_timeout =
685 !cancel_delayed_work(&trf->timeout_work);
686 trf7970a_drain_fifo(trf, status);
Mark A. Greer4dd836e2014-03-25 08:54:32 -0700687 } else if (status == TRF7970A_IRQ_STATUS_TX) {
688 trf7970a_cmd(trf, TRF7970A_CMD_FIFO_RESET);
689 } else {
Mark A. Greer165063f2014-03-10 11:56:22 -0700690 trf7970a_send_err_upstream(trf, -EIO);
691 }
692 break;
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700693 case TRF7970A_ST_WAIT_TO_ISSUE_EOF:
694 if (status != TRF7970A_IRQ_STATUS_TX)
695 trf7970a_send_err_upstream(trf, -EIO);
696 break;
Mark A. Greer165063f2014-03-10 11:56:22 -0700697 default:
698 dev_err(trf->dev, "%s - Driver in invalid state: %d\n",
699 __func__, trf->state);
700 }
701
702 mutex_unlock(&trf->lock);
703 return IRQ_HANDLED;
704}
705
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700706static void trf7970a_issue_eof(struct trf7970a *trf)
707{
708 int ret;
709
710 dev_dbg(trf->dev, "Issuing EOF\n");
711
712 ret = trf7970a_cmd(trf, TRF7970A_CMD_FIFO_RESET);
713 if (ret)
714 trf7970a_send_err_upstream(trf, ret);
715
716 ret = trf7970a_cmd(trf, TRF7970A_CMD_EOF);
717 if (ret)
718 trf7970a_send_err_upstream(trf, ret);
719
720 trf->state = TRF7970A_ST_WAIT_FOR_RX_DATA;
721
722 dev_dbg(trf->dev, "Setting timeout for %d ms, state: %d\n",
723 trf->timeout, trf->state);
724
725 schedule_delayed_work(&trf->timeout_work,
726 msecs_to_jiffies(trf->timeout));
727}
728
Mark A. Greer165063f2014-03-10 11:56:22 -0700729static void trf7970a_timeout_work_handler(struct work_struct *work)
730{
731 struct trf7970a *trf = container_of(work, struct trf7970a,
732 timeout_work.work);
733
734 dev_dbg(trf->dev, "Timeout - state: %d, ignore_timeout: %d\n",
735 trf->state, trf->ignore_timeout);
736
737 mutex_lock(&trf->lock);
738
739 if (trf->ignore_timeout)
740 trf->ignore_timeout = false;
741 else if (trf->state == TRF7970A_ST_WAIT_FOR_RX_DATA_CONT)
742 trf7970a_send_upstream(trf); /* No more rx data so send up */
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700743 else if (trf->state == TRF7970A_ST_WAIT_TO_ISSUE_EOF)
744 trf7970a_issue_eof(trf);
Mark A. Greer165063f2014-03-10 11:56:22 -0700745 else
746 trf7970a_send_err_upstream(trf, -ETIMEDOUT);
747
748 mutex_unlock(&trf->lock);
749}
750
751static int trf7970a_init(struct trf7970a *trf)
752{
753 int ret;
754
755 dev_dbg(trf->dev, "Initializing device - state: %d\n", trf->state);
756
757 ret = trf7970a_cmd(trf, TRF7970A_CMD_SOFT_INIT);
758 if (ret)
759 goto err_out;
760
761 ret = trf7970a_cmd(trf, TRF7970A_CMD_IDLE);
762 if (ret)
763 goto err_out;
764
Mark A. Greerb887eb02014-03-25 08:54:31 -0700765 /* Must clear NFC Target Detection Level reg due to erratum */
766 ret = trf7970a_write(trf, TRF7970A_NFC_TARGET_LEVEL, 0);
767 if (ret)
768 goto err_out;
769
Mark A. Greer165063f2014-03-10 11:56:22 -0700770 ret = trf7970a_write(trf, TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS,
771 TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLH_96 |
772 TRF7970A_ADJUTABLE_FIFO_IRQ_LEVELS_WLL_32);
773 if (ret)
774 goto err_out;
775
776 ret = trf7970a_write(trf, TRF7970A_SPECIAL_FCN_REG1, 0);
777 if (ret)
778 goto err_out;
779
780 trf->special_fcn_reg1 = 0;
781
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700782 trf->iso_ctrl = 0xff;
Mark A. Greer165063f2014-03-10 11:56:22 -0700783 return 0;
784
785err_out:
786 dev_dbg(trf->dev, "Couldn't init device: %d\n", ret);
787 return ret;
788}
789
790static void trf7970a_switch_rf_off(struct trf7970a *trf)
791{
792 dev_dbg(trf->dev, "Switching rf off\n");
793
Mark A. Greera1d2dc52014-03-25 08:54:37 -0700794 trf->chip_status_ctrl &= ~TRF7970A_CHIP_STATUS_RF_ON;
795
796 trf7970a_write(trf, TRF7970A_CHIP_STATUS_CTRL, trf->chip_status_ctrl);
797
Mark A. Greer165063f2014-03-10 11:56:22 -0700798 gpio_set_value(trf->en_gpio, 0);
799 gpio_set_value(trf->en2_gpio, 0);
800
801 trf->aborting = false;
802 trf->state = TRF7970A_ST_OFF;
803}
804
805static int trf7970a_switch_rf_on(struct trf7970a *trf)
806{
807 unsigned long delay;
808 int ret;
809
810 dev_dbg(trf->dev, "Switching rf on\n");
811
812 if (trf->powering_up)
813 usleep_range(5000, 6000);
814
815 gpio_set_value(trf->en2_gpio, 1);
816 usleep_range(1000, 2000);
817 gpio_set_value(trf->en_gpio, 1);
818
819 /* The delay between enabling the trf7970a and issuing the first
820 * command is significantly longer the very first time after powering
821 * up. Make sure the longer delay is only done the first time.
822 */
823 if (trf->powering_up) {
824 delay = 20000;
825 trf->powering_up = false;
826 } else {
827 delay = 5000;
828 }
829
830 usleep_range(delay, delay + 1000);
831
832 ret = trf7970a_init(trf);
833 if (ret)
834 trf7970a_switch_rf_off(trf);
835 else
836 trf->state = TRF7970A_ST_IDLE;
837
838 return ret;
839}
840
841static int trf7970a_switch_rf(struct nfc_digital_dev *ddev, bool on)
842{
843 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
844 int ret = 0;
845
846 dev_dbg(trf->dev, "Switching RF - state: %d, on: %d\n", trf->state, on);
847
848 mutex_lock(&trf->lock);
849
850 if (on) {
851 switch (trf->state) {
852 case TRF7970A_ST_OFF:
853 ret = trf7970a_switch_rf_on(trf);
854 break;
855 case TRF7970A_ST_IDLE:
856 case TRF7970A_ST_IDLE_RX_BLOCKED:
857 break;
858 default:
859 dev_err(trf->dev, "%s - Invalid request: %d %d\n",
860 __func__, trf->state, on);
861 trf7970a_switch_rf_off(trf);
862 }
863 } else {
864 switch (trf->state) {
865 case TRF7970A_ST_OFF:
866 break;
867 default:
868 dev_err(trf->dev, "%s - Invalid request: %d %d\n",
869 __func__, trf->state, on);
870 /* FALLTHROUGH */
871 case TRF7970A_ST_IDLE:
872 case TRF7970A_ST_IDLE_RX_BLOCKED:
873 trf7970a_switch_rf_off(trf);
874 }
875 }
876
877 mutex_unlock(&trf->lock);
878 return ret;
879}
880
881static int trf7970a_config_rf_tech(struct trf7970a *trf, int tech)
882{
883 int ret = 0;
884
885 dev_dbg(trf->dev, "rf technology: %d\n", tech);
886
887 switch (tech) {
888 case NFC_DIGITAL_RF_TECH_106A:
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700889 trf->iso_ctrl_tech = TRF7970A_ISO_CTRL_14443A_106;
Mark A. Greer12e9ade2014-03-25 08:54:35 -0700890 trf->modulator_sys_clk_ctrl = TRF7970A_MODULATOR_DEPTH_OOK;
Mark A. Greer165063f2014-03-10 11:56:22 -0700891 break;
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700892 case NFC_DIGITAL_RF_TECH_ISO15693:
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700893 trf->iso_ctrl_tech = TRF7970A_ISO_CTRL_15693_SGL_1OF4_2648;
Mark A. Greer12e9ade2014-03-25 08:54:35 -0700894 trf->modulator_sys_clk_ctrl = TRF7970A_MODULATOR_DEPTH_OOK;
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700895 break;
Mark A. Greer165063f2014-03-10 11:56:22 -0700896 default:
897 dev_dbg(trf->dev, "Unsupported rf technology: %d\n", tech);
898 return -EINVAL;
899 }
900
901 trf->technology = tech;
902
903 return ret;
904}
905
906static int trf7970a_config_framing(struct trf7970a *trf, int framing)
907{
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700908 u8 iso_ctrl = trf->iso_ctrl_tech;
909 int ret;
910
Mark A. Greer165063f2014-03-10 11:56:22 -0700911 dev_dbg(trf->dev, "framing: %d\n", framing);
912
913 switch (framing) {
914 case NFC_DIGITAL_FRAMING_NFCA_SHORT:
915 case NFC_DIGITAL_FRAMING_NFCA_STANDARD:
916 trf->tx_cmd = TRF7970A_CMD_TRANSMIT_NO_CRC;
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700917 iso_ctrl |= TRF7970A_ISO_CTRL_RX_CRC_N;
Mark A. Greer165063f2014-03-10 11:56:22 -0700918 break;
919 case NFC_DIGITAL_FRAMING_NFCA_STANDARD_WITH_CRC_A:
Mark A. Greer80062892014-03-10 11:56:23 -0700920 case NFC_DIGITAL_FRAMING_NFCA_T4T:
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700921 case NFC_DIGITAL_FRAMING_ISO15693_INVENTORY:
922 case NFC_DIGITAL_FRAMING_ISO15693_T5T:
Mark A. Greer165063f2014-03-10 11:56:22 -0700923 trf->tx_cmd = TRF7970A_CMD_TRANSMIT;
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700924 iso_ctrl &= ~TRF7970A_ISO_CTRL_RX_CRC_N;
Mark A. Greer165063f2014-03-10 11:56:22 -0700925 break;
926 case NFC_DIGITAL_FRAMING_NFCA_T2T:
927 trf->tx_cmd = TRF7970A_CMD_TRANSMIT;
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700928 iso_ctrl |= TRF7970A_ISO_CTRL_RX_CRC_N;
Mark A. Greer165063f2014-03-10 11:56:22 -0700929 break;
930 default:
931 dev_dbg(trf->dev, "Unsupported Framing: %d\n", framing);
932 return -EINVAL;
933 }
934
935 trf->framing = framing;
936
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700937 if (iso_ctrl != trf->iso_ctrl) {
938 ret = trf7970a_write(trf, TRF7970A_ISO_CTRL, iso_ctrl);
939 if (ret)
940 return ret;
941
942 trf->iso_ctrl = iso_ctrl;
Mark A. Greera0822a72014-03-25 08:54:34 -0700943
944 ret = trf7970a_write(trf, TRF7970A_MODULATOR_SYS_CLK_CTRL,
Mark A. Greer12e9ade2014-03-25 08:54:35 -0700945 trf->modulator_sys_clk_ctrl);
Mark A. Greera0822a72014-03-25 08:54:34 -0700946 if (ret)
947 return ret;
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700948 }
949
Mark A. Greera1d2dc52014-03-25 08:54:37 -0700950 if (!(trf->chip_status_ctrl & TRF7970A_CHIP_STATUS_RF_ON)) {
951 ret = trf7970a_write(trf, TRF7970A_CHIP_STATUS_CTRL,
952 trf->chip_status_ctrl |
953 TRF7970A_CHIP_STATUS_RF_ON);
954 if (ret)
955 return ret;
956
957 trf->chip_status_ctrl |= TRF7970A_CHIP_STATUS_RF_ON;
958
959 usleep_range(5000, 6000);
960 }
961
Mark A. Greer49d19cc2014-03-25 08:54:33 -0700962 return 0;
Mark A. Greer165063f2014-03-10 11:56:22 -0700963}
964
965static int trf7970a_in_configure_hw(struct nfc_digital_dev *ddev, int type,
966 int param)
967{
968 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
969 int ret = 0;
970
971 dev_dbg(trf->dev, "Configure hw - type: %d, param: %d\n", type, param);
972
973 mutex_lock(&trf->lock);
974
975 if (trf->state == TRF7970A_ST_OFF) {
976 ret = trf7970a_switch_rf_on(trf);
977 if (ret)
978 goto err_out;
979 }
980
981 switch (type) {
982 case NFC_DIGITAL_CONFIG_RF_TECH:
983 ret = trf7970a_config_rf_tech(trf, param);
984 break;
985 case NFC_DIGITAL_CONFIG_FRAMING:
986 ret = trf7970a_config_framing(trf, param);
987 break;
988 default:
989 dev_dbg(trf->dev, "Unknown type: %d\n", type);
990 ret = -EINVAL;
991 }
992
993err_out:
994 mutex_unlock(&trf->lock);
995 return ret;
996}
997
Mark A. Greer9d9304b2014-03-10 11:56:24 -0700998static int trf7970a_is_iso15693_write_or_lock(u8 cmd)
999{
1000 switch (cmd) {
1001 case ISO15693_CMD_WRITE_SINGLE_BLOCK:
1002 case ISO15693_CMD_LOCK_BLOCK:
1003 case ISO15693_CMD_WRITE_MULTIPLE_BLOCK:
1004 case ISO15693_CMD_WRITE_AFI:
1005 case ISO15693_CMD_LOCK_AFI:
1006 case ISO15693_CMD_WRITE_DSFID:
1007 case ISO15693_CMD_LOCK_DSFID:
1008 return 1;
1009 break;
1010 default:
1011 return 0;
1012 }
1013}
1014
Mark A. Greer165063f2014-03-10 11:56:22 -07001015static int trf7970a_per_cmd_config(struct trf7970a *trf, struct sk_buff *skb)
1016{
1017 u8 *req = skb->data;
Mark A. Greer9d9304b2014-03-10 11:56:24 -07001018 u8 special_fcn_reg1, iso_ctrl;
Mark A. Greer165063f2014-03-10 11:56:22 -07001019 int ret;
1020
Mark A. Greer9d9304b2014-03-10 11:56:24 -07001021 trf->issue_eof = false;
1022
Mark A. Greer165063f2014-03-10 11:56:22 -07001023 /* When issuing Type 2 read command, make sure the '4_bit_RX' bit in
1024 * special functions register 1 is cleared; otherwise, its a write or
1025 * sector select command and '4_bit_RX' must be set.
Mark A. Greer9d9304b2014-03-10 11:56:24 -07001026 *
1027 * When issuing an ISO 15693 command, inspect the flags byte to see
1028 * what speed to use. Also, remember if the OPTION flag is set on
1029 * a Type 5 write or lock command so the driver will know that it
1030 * has to send an EOF in order to get a response.
Mark A. Greer165063f2014-03-10 11:56:22 -07001031 */
1032 if ((trf->technology == NFC_DIGITAL_RF_TECH_106A) &&
1033 (trf->framing == NFC_DIGITAL_FRAMING_NFCA_T2T)) {
1034 if (req[0] == NFC_T2T_CMD_READ)
1035 special_fcn_reg1 = 0;
1036 else
1037 special_fcn_reg1 = TRF7970A_SPECIAL_FCN_REG1_4_BIT_RX;
1038
1039 if (special_fcn_reg1 != trf->special_fcn_reg1) {
1040 ret = trf7970a_write(trf, TRF7970A_SPECIAL_FCN_REG1,
1041 special_fcn_reg1);
1042 if (ret)
1043 return ret;
1044
1045 trf->special_fcn_reg1 = special_fcn_reg1;
1046 }
Mark A. Greer9d9304b2014-03-10 11:56:24 -07001047 } else if (trf->technology == NFC_DIGITAL_RF_TECH_ISO15693) {
1048 iso_ctrl = trf->iso_ctrl & ~TRF7970A_ISO_CTRL_RFID_SPEED_MASK;
1049
1050 switch (req[0] & ISO15693_REQ_FLAG_SPEED_MASK) {
1051 case 0x00:
1052 iso_ctrl |= TRF7970A_ISO_CTRL_15693_SGL_1OF4_662;
1053 break;
1054 case ISO15693_REQ_FLAG_SUB_CARRIER:
1055 iso_ctrl |= TRF7970A_ISO_CTRL_15693_DBL_1OF4_667a;
1056 break;
1057 case ISO15693_REQ_FLAG_DATA_RATE:
1058 iso_ctrl |= TRF7970A_ISO_CTRL_15693_SGL_1OF4_2648;
1059 break;
1060 case (ISO15693_REQ_FLAG_SUB_CARRIER |
1061 ISO15693_REQ_FLAG_DATA_RATE):
1062 iso_ctrl |= TRF7970A_ISO_CTRL_15693_DBL_1OF4_2669;
1063 break;
1064 }
1065
1066 if (iso_ctrl != trf->iso_ctrl) {
1067 ret = trf7970a_write(trf, TRF7970A_ISO_CTRL, iso_ctrl);
1068 if (ret)
1069 return ret;
1070
1071 trf->iso_ctrl = iso_ctrl;
1072 }
1073
1074 if ((trf->framing == NFC_DIGITAL_FRAMING_ISO15693_T5T) &&
1075 trf7970a_is_iso15693_write_or_lock(req[1]) &&
1076 (req[0] & ISO15693_REQ_FLAG_OPTION))
1077 trf->issue_eof = true;
Mark A. Greer165063f2014-03-10 11:56:22 -07001078 }
1079
1080 return 0;
1081}
1082
1083static int trf7970a_in_send_cmd(struct nfc_digital_dev *ddev,
1084 struct sk_buff *skb, u16 timeout,
1085 nfc_digital_cmd_complete_t cb, void *arg)
1086{
1087 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
1088 char *prefix;
1089 unsigned int len;
1090 int ret;
1091
1092 dev_dbg(trf->dev, "New request - state: %d, timeout: %d ms, len: %d\n",
1093 trf->state, timeout, skb->len);
1094
1095 if (skb->len > TRF7970A_TX_MAX)
1096 return -EINVAL;
1097
1098 mutex_lock(&trf->lock);
1099
1100 if ((trf->state != TRF7970A_ST_IDLE) &&
1101 (trf->state != TRF7970A_ST_IDLE_RX_BLOCKED)) {
1102 dev_err(trf->dev, "%s - Bogus state: %d\n", __func__,
1103 trf->state);
1104 ret = -EIO;
1105 goto out_err;
1106 }
1107
1108 if (trf->aborting) {
1109 dev_dbg(trf->dev, "Abort process complete\n");
1110 trf->aborting = false;
1111 ret = -ECANCELED;
1112 goto out_err;
1113 }
1114
1115 trf->rx_skb = nfc_alloc_recv_skb(TRF7970A_RX_SKB_ALLOC_SIZE,
1116 GFP_KERNEL);
1117 if (!trf->rx_skb) {
1118 dev_dbg(trf->dev, "Can't alloc rx_skb\n");
1119 ret = -ENOMEM;
1120 goto out_err;
1121 }
1122
1123 if (trf->state == TRF7970A_ST_IDLE_RX_BLOCKED) {
1124 ret = trf7970a_cmd(trf, TRF7970A_CMD_ENABLE_RX);
1125 if (ret)
1126 goto out_err;
1127
1128 trf->state = TRF7970A_ST_IDLE;
1129 }
1130
1131 ret = trf7970a_per_cmd_config(trf, skb);
1132 if (ret)
1133 goto out_err;
1134
1135 trf->ddev = ddev;
1136 trf->tx_skb = skb;
1137 trf->cb = cb;
1138 trf->cb_arg = arg;
1139 trf->timeout = timeout;
1140 trf->ignore_timeout = false;
1141
1142 len = skb->len;
1143 prefix = skb_push(skb, TRF7970A_TX_SKB_HEADROOM);
1144
1145 /* TX data must be prefixed with a FIFO reset cmd, a cmd that depends
1146 * on what the current framing is, the address of the TX length byte 1
1147 * register (0x1d), and the 2 byte length of the data to be transmitted.
1148 */
1149 prefix[0] = TRF7970A_CMD_BIT_CTRL |
1150 TRF7970A_CMD_BIT_OPCODE(TRF7970A_CMD_FIFO_RESET);
1151 prefix[1] = TRF7970A_CMD_BIT_CTRL |
1152 TRF7970A_CMD_BIT_OPCODE(trf->tx_cmd);
1153 prefix[2] = TRF7970A_CMD_BIT_CONTINUOUS | TRF7970A_TX_LENGTH_BYTE1;
1154
1155 if (trf->framing == NFC_DIGITAL_FRAMING_NFCA_SHORT) {
1156 prefix[3] = 0x00;
1157 prefix[4] = 0x0f; /* 7 bits */
1158 } else {
1159 prefix[3] = (len & 0xf00) >> 4;
1160 prefix[3] |= ((len & 0xf0) >> 4);
1161 prefix[4] = ((len & 0x0f) << 4);
1162 }
1163
1164 len = min_t(int, skb->len, TRF7970A_FIFO_SIZE);
1165
1166 usleep_range(1000, 2000);
1167
1168 ret = trf7970a_transmit(trf, skb, len);
1169 if (ret) {
1170 kfree_skb(trf->rx_skb);
1171 trf->rx_skb = NULL;
1172 }
1173
1174out_err:
1175 mutex_unlock(&trf->lock);
1176 return ret;
1177}
1178
1179static int trf7970a_tg_configure_hw(struct nfc_digital_dev *ddev,
1180 int type, int param)
1181{
1182 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
1183
1184 dev_dbg(trf->dev, "Unsupported interface\n");
1185
1186 return -EINVAL;
1187}
1188
1189static int trf7970a_tg_send_cmd(struct nfc_digital_dev *ddev,
1190 struct sk_buff *skb, u16 timeout,
1191 nfc_digital_cmd_complete_t cb, void *arg)
1192{
1193 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
1194
1195 dev_dbg(trf->dev, "Unsupported interface\n");
1196
1197 return -EINVAL;
1198}
1199
1200static int trf7970a_tg_listen(struct nfc_digital_dev *ddev,
1201 u16 timeout, nfc_digital_cmd_complete_t cb, void *arg)
1202{
1203 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
1204
1205 dev_dbg(trf->dev, "Unsupported interface\n");
1206
1207 return -EINVAL;
1208}
1209
1210static int trf7970a_tg_listen_mdaa(struct nfc_digital_dev *ddev,
1211 struct digital_tg_mdaa_params *mdaa_params,
1212 u16 timeout, nfc_digital_cmd_complete_t cb, void *arg)
1213{
1214 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
1215
1216 dev_dbg(trf->dev, "Unsupported interface\n");
1217
1218 return -EINVAL;
1219}
1220
1221static void trf7970a_abort_cmd(struct nfc_digital_dev *ddev)
1222{
1223 struct trf7970a *trf = nfc_digital_get_drvdata(ddev);
1224
1225 dev_dbg(trf->dev, "Abort process initiated\n");
1226
1227 mutex_lock(&trf->lock);
Mark A. Greer5876bc752014-03-25 08:54:30 -07001228
1229 switch (trf->state) {
1230 case TRF7970A_ST_WAIT_FOR_TX_FIFO:
1231 case TRF7970A_ST_WAIT_FOR_RX_DATA:
1232 case TRF7970A_ST_WAIT_FOR_RX_DATA_CONT:
1233 case TRF7970A_ST_WAIT_TO_ISSUE_EOF:
1234 trf->aborting = true;
1235 break;
1236 default:
1237 break;
1238 }
1239
Mark A. Greer165063f2014-03-10 11:56:22 -07001240 mutex_unlock(&trf->lock);
1241}
1242
1243static struct nfc_digital_ops trf7970a_nfc_ops = {
1244 .in_configure_hw = trf7970a_in_configure_hw,
1245 .in_send_cmd = trf7970a_in_send_cmd,
1246 .tg_configure_hw = trf7970a_tg_configure_hw,
1247 .tg_send_cmd = trf7970a_tg_send_cmd,
1248 .tg_listen = trf7970a_tg_listen,
1249 .tg_listen_mdaa = trf7970a_tg_listen_mdaa,
1250 .switch_rf = trf7970a_switch_rf,
1251 .abort_cmd = trf7970a_abort_cmd,
1252};
1253
1254static int trf7970a_probe(struct spi_device *spi)
1255{
1256 struct device_node *np = spi->dev.of_node;
1257 const struct spi_device_id *id = spi_get_device_id(spi);
1258 struct trf7970a *trf;
Mark A. Greerebcc5a02014-03-25 08:54:36 -07001259 int uvolts, ret;
Mark A. Greer165063f2014-03-10 11:56:22 -07001260
1261 if (!np) {
1262 dev_err(&spi->dev, "No Device Tree entry\n");
1263 return -EINVAL;
1264 }
1265
1266 trf = devm_kzalloc(&spi->dev, sizeof(*trf), GFP_KERNEL);
1267 if (!trf)
1268 return -ENOMEM;
1269
1270 trf->state = TRF7970A_ST_OFF;
1271 trf->dev = &spi->dev;
1272 trf->spi = spi;
1273 trf->quirks = id->driver_data;
1274
1275 spi->mode = SPI_MODE_1;
1276 spi->bits_per_word = 8;
1277
1278 /* There are two enable pins - both must be present */
1279 trf->en_gpio = of_get_named_gpio(np, "ti,enable-gpios", 0);
1280 if (!gpio_is_valid(trf->en_gpio)) {
1281 dev_err(trf->dev, "No EN GPIO property\n");
1282 return trf->en_gpio;
1283 }
1284
1285 ret = devm_gpio_request_one(trf->dev, trf->en_gpio,
1286 GPIOF_DIR_OUT | GPIOF_INIT_LOW, "EN");
1287 if (ret) {
1288 dev_err(trf->dev, "Can't request EN GPIO: %d\n", ret);
1289 return ret;
1290 }
1291
1292 trf->en2_gpio = of_get_named_gpio(np, "ti,enable-gpios", 1);
1293 if (!gpio_is_valid(trf->en2_gpio)) {
1294 dev_err(trf->dev, "No EN2 GPIO property\n");
1295 return trf->en2_gpio;
1296 }
1297
1298 ret = devm_gpio_request_one(trf->dev, trf->en2_gpio,
1299 GPIOF_DIR_OUT | GPIOF_INIT_LOW, "EN2");
1300 if (ret) {
1301 dev_err(trf->dev, "Can't request EN2 GPIO: %d\n", ret);
1302 return ret;
1303 }
1304
1305 ret = devm_request_threaded_irq(trf->dev, spi->irq, NULL,
1306 trf7970a_irq, IRQF_TRIGGER_RISING | IRQF_ONESHOT,
1307 "trf7970a", trf);
1308 if (ret) {
1309 dev_err(trf->dev, "Can't request IRQ#%d: %d\n", spi->irq, ret);
1310 return ret;
1311 }
1312
1313 mutex_init(&trf->lock);
1314 INIT_DELAYED_WORK(&trf->timeout_work, trf7970a_timeout_work_handler);
1315
1316 trf->regulator = devm_regulator_get(&spi->dev, "vin");
1317 if (IS_ERR(trf->regulator)) {
1318 ret = PTR_ERR(trf->regulator);
1319 dev_err(trf->dev, "Can't get VIN regulator: %d\n", ret);
1320 goto err_destroy_lock;
1321 }
1322
1323 ret = regulator_enable(trf->regulator);
1324 if (ret) {
1325 dev_err(trf->dev, "Can't enable VIN: %d\n", ret);
1326 goto err_destroy_lock;
1327 }
1328
Mark A. Greerebcc5a02014-03-25 08:54:36 -07001329 uvolts = regulator_get_voltage(trf->regulator);
1330
1331 if (uvolts > 4000000)
1332 trf->chip_status_ctrl = TRF7970A_CHIP_STATUS_VRS5_3;
1333
Mark A. Greer165063f2014-03-10 11:56:22 -07001334 trf->powering_up = true;
1335
1336 trf->ddev = nfc_digital_allocate_device(&trf7970a_nfc_ops,
1337 TRF7970A_SUPPORTED_PROTOCOLS,
1338 NFC_DIGITAL_DRV_CAPS_IN_CRC, TRF7970A_TX_SKB_HEADROOM,
1339 0);
1340 if (!trf->ddev) {
1341 dev_err(trf->dev, "Can't allocate NFC digital device\n");
1342 ret = -ENOMEM;
1343 goto err_disable_regulator;
1344 }
1345
1346 nfc_digital_set_parent_dev(trf->ddev, trf->dev);
1347 nfc_digital_set_drvdata(trf->ddev, trf);
1348 spi_set_drvdata(spi, trf);
1349
1350 ret = nfc_digital_register_device(trf->ddev);
1351 if (ret) {
1352 dev_err(trf->dev, "Can't register NFC digital device: %d\n",
1353 ret);
1354 goto err_free_ddev;
1355 }
1356
1357 return 0;
1358
1359err_free_ddev:
1360 nfc_digital_free_device(trf->ddev);
1361err_disable_regulator:
1362 regulator_disable(trf->regulator);
1363err_destroy_lock:
1364 mutex_destroy(&trf->lock);
1365 return ret;
1366}
1367
1368static int trf7970a_remove(struct spi_device *spi)
1369{
1370 struct trf7970a *trf = spi_get_drvdata(spi);
1371
1372 mutex_lock(&trf->lock);
1373
1374 trf7970a_switch_rf_off(trf);
1375 trf7970a_init(trf);
1376
1377 switch (trf->state) {
1378 case TRF7970A_ST_WAIT_FOR_TX_FIFO:
1379 case TRF7970A_ST_WAIT_FOR_RX_DATA:
1380 case TRF7970A_ST_WAIT_FOR_RX_DATA_CONT:
Mark A. Greer9d9304b2014-03-10 11:56:24 -07001381 case TRF7970A_ST_WAIT_TO_ISSUE_EOF:
Mark A. Greer165063f2014-03-10 11:56:22 -07001382 trf7970a_send_err_upstream(trf, -ECANCELED);
1383 break;
1384 default:
1385 break;
1386 }
1387
1388 mutex_unlock(&trf->lock);
1389
1390 nfc_digital_unregister_device(trf->ddev);
1391 nfc_digital_free_device(trf->ddev);
1392
1393 regulator_disable(trf->regulator);
1394
1395 mutex_destroy(&trf->lock);
1396
1397 return 0;
1398}
1399
1400static const struct spi_device_id trf7970a_id_table[] = {
1401 { "trf7970a", TRF7970A_QUIRK_IRQ_STATUS_READ_ERRATA },
1402 { }
1403};
1404MODULE_DEVICE_TABLE(spi, trf7970a_id_table);
1405
1406static struct spi_driver trf7970a_spi_driver = {
1407 .probe = trf7970a_probe,
1408 .remove = trf7970a_remove,
1409 .id_table = trf7970a_id_table,
1410 .driver = {
1411 .name = "trf7970a",
1412 .owner = THIS_MODULE,
1413 },
1414};
1415
1416module_spi_driver(trf7970a_spi_driver);
1417
1418MODULE_AUTHOR("Mark A. Greer <mgreer@animalcreek.com>");
1419MODULE_LICENSE("GPL v2");
1420MODULE_DESCRIPTION("TI trf7970a RFID/NFC Transceiver Driver");