2 * Low Level Transport (NDLC) Driver for STMicroelectronics NFC Chip
4 * Copyright (C) 2014 STMicroelectronics SAS. All rights reserved.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #include <linux/sched.h>
20 #include <net/nfc/nci_core.h>
25 #define NDLC_TIMER_T1 100
26 #define NDLC_TIMER_T1_WAIT 400
27 #define NDLC_TIMER_T2 1200
29 #define PCB_TYPE_DATAFRAME 0x80
30 #define PCB_TYPE_SUPERVISOR 0xc0
31 #define PCB_TYPE_MASK PCB_TYPE_SUPERVISOR
33 #define PCB_SYNC_ACK 0x20
34 #define PCB_SYNC_NACK 0x10
35 #define PCB_SYNC_WAIT 0x30
36 #define PCB_SYNC_NOINFO 0x00
37 #define PCB_SYNC_MASK PCB_SYNC_WAIT
39 #define PCB_DATAFRAME_RETRANSMIT_YES 0x00
40 #define PCB_DATAFRAME_RETRANSMIT_NO 0x04
41 #define PCB_DATAFRAME_RETRANSMIT_MASK PCB_DATAFRAME_RETRANSMIT_NO
43 #define PCB_SUPERVISOR_RETRANSMIT_YES 0x00
44 #define PCB_SUPERVISOR_RETRANSMIT_NO 0x02
45 #define PCB_SUPERVISOR_RETRANSMIT_MASK PCB_SUPERVISOR_RETRANSMIT_NO
47 #define PCB_FRAME_CRC_INFO_PRESENT 0x08
48 #define PCB_FRAME_CRC_INFO_NOTPRESENT 0x00
49 #define PCB_FRAME_CRC_INFO_MASK PCB_FRAME_CRC_INFO_PRESENT
51 #define NDLC_DUMP_SKB(info, skb) \
53 pr_debug("%s:\n", info); \
54 print_hex_dump(KERN_DEBUG, "ndlc: ", DUMP_PREFIX_OFFSET, \
55 16, 1, skb->data, skb->len, 0); \
58 int ndlc_open(struct llt_ndlc *ndlc)
60 /* toggle reset pin */
61 ndlc->ops->enable(ndlc->phy_id);
65 EXPORT_SYMBOL(ndlc_open);
67 void ndlc_close(struct llt_ndlc *ndlc)
69 struct nci_mode_set_cmd cmd;
71 cmd.cmd_type = ST21NFCB_NCI_SET_NFC_MODE;
74 /* toggle reset pin */
75 ndlc->ops->enable(ndlc->phy_id);
77 nci_prop_cmd(ndlc->ndev, ST21NFCB_NCI_CORE_PROP,
78 sizeof(struct nci_mode_set_cmd), (__u8 *)&cmd);
81 ndlc->ops->disable(ndlc->phy_id);
83 EXPORT_SYMBOL(ndlc_close);
85 int ndlc_send(struct llt_ndlc *ndlc, struct sk_buff *skb)
88 u8 pcb = PCB_TYPE_DATAFRAME | PCB_DATAFRAME_RETRANSMIT_NO |
89 PCB_FRAME_CRC_INFO_NOTPRESENT;
91 *skb_push(skb, 1) = pcb;
92 skb_queue_tail(&ndlc->send_q, skb);
94 schedule_work(&ndlc->sm_work);
98 EXPORT_SYMBOL(ndlc_send);
100 static void llt_ndlc_send_queue(struct llt_ndlc *ndlc)
104 unsigned long time_sent;
106 if (ndlc->send_q.qlen)
107 pr_debug("sendQlen=%d unackQlen=%d\n",
108 ndlc->send_q.qlen, ndlc->ack_pending_q.qlen);
110 while (ndlc->send_q.qlen) {
111 skb = skb_dequeue(&ndlc->send_q);
112 NDLC_DUMP_SKB("ndlc frame written", skb);
113 r = ndlc->ops->write(ndlc->phy_id, skb);
115 ndlc->hard_fault = r;
119 *(unsigned long *)skb->cb = time_sent;
121 skb_queue_tail(&ndlc->ack_pending_q, skb);
123 /* start timer t1 for ndlc aknowledge */
124 ndlc->t1_active = true;
125 mod_timer(&ndlc->t1_timer, time_sent +
126 msecs_to_jiffies(NDLC_TIMER_T1));
127 /* start timer t2 for chip availability */
128 ndlc->t2_active = true;
129 mod_timer(&ndlc->t2_timer, time_sent +
130 msecs_to_jiffies(NDLC_TIMER_T2));
134 static void llt_ndlc_requeue_data_pending(struct llt_ndlc *ndlc)
139 while ((skb = skb_dequeue_tail(&ndlc->ack_pending_q))) {
141 switch (pcb & PCB_TYPE_MASK) {
142 case PCB_TYPE_SUPERVISOR:
143 skb->data[0] = (pcb & ~PCB_SUPERVISOR_RETRANSMIT_MASK) |
144 PCB_SUPERVISOR_RETRANSMIT_YES;
146 case PCB_TYPE_DATAFRAME:
147 skb->data[0] = (pcb & ~PCB_DATAFRAME_RETRANSMIT_MASK) |
148 PCB_DATAFRAME_RETRANSMIT_YES;
151 pr_err("UNKNOWN Packet Control Byte=%d\n", pcb);
155 skb_queue_head(&ndlc->send_q, skb);
159 static void llt_ndlc_rcv_queue(struct llt_ndlc *ndlc)
163 unsigned long time_sent;
165 if (ndlc->rcv_q.qlen)
166 pr_debug("rcvQlen=%d\n", ndlc->rcv_q.qlen);
168 while ((skb = skb_dequeue(&ndlc->rcv_q)) != NULL) {
171 if ((pcb & PCB_TYPE_MASK) == PCB_TYPE_SUPERVISOR) {
172 switch (pcb & PCB_SYNC_MASK) {
174 del_timer_sync(&ndlc->t1_timer);
175 del_timer_sync(&ndlc->t2_timer);
176 ndlc->t2_active = false;
177 ndlc->t1_active = false;
180 llt_ndlc_requeue_data_pending(ndlc);
181 llt_ndlc_send_queue(ndlc);
182 /* start timer t1 for ndlc aknowledge */
184 ndlc->t1_active = true;
185 mod_timer(&ndlc->t1_timer, time_sent +
186 msecs_to_jiffies(NDLC_TIMER_T1));
190 ndlc->t1_active = true;
191 mod_timer(&ndlc->t1_timer, time_sent +
192 msecs_to_jiffies(NDLC_TIMER_T1_WAIT));
195 pr_err("UNKNOWN Packet Control Byte=%d\n", pcb);
200 nci_recv_frame(ndlc->ndev, skb);
205 static void llt_ndlc_sm_work(struct work_struct *work)
207 struct llt_ndlc *ndlc = container_of(work, struct llt_ndlc, sm_work);
209 llt_ndlc_send_queue(ndlc);
210 llt_ndlc_rcv_queue(ndlc);
212 if (ndlc->t1_active && timer_pending(&ndlc->t1_timer) == 0) {
214 ("Handle T1(recv SUPERVISOR) elapsed (T1 now inactive)\n");
215 ndlc->t1_active = false;
217 llt_ndlc_requeue_data_pending(ndlc);
218 llt_ndlc_send_queue(ndlc);
221 if (ndlc->t2_active && timer_pending(&ndlc->t2_timer) == 0) {
222 pr_debug("Handle T2(recv DATA) elapsed (T2 now inactive)\n");
223 ndlc->t2_active = false;
224 ndlc->t1_active = false;
225 del_timer_sync(&ndlc->t1_timer);
226 del_timer_sync(&ndlc->t2_timer);
228 ndlc->hard_fault = -EREMOTEIO;
232 void ndlc_recv(struct llt_ndlc *ndlc, struct sk_buff *skb)
235 pr_err("NULL Frame -> link is dead\n");
236 ndlc->hard_fault = -EREMOTEIO;
239 NDLC_DUMP_SKB("incoming frame", skb);
240 skb_queue_tail(&ndlc->rcv_q, skb);
243 schedule_work(&ndlc->sm_work);
245 EXPORT_SYMBOL(ndlc_recv);
247 static void ndlc_t1_timeout(unsigned long data)
249 struct llt_ndlc *ndlc = (struct llt_ndlc *)data;
253 schedule_work(&ndlc->sm_work);
256 static void ndlc_t2_timeout(unsigned long data)
258 struct llt_ndlc *ndlc = (struct llt_ndlc *)data;
262 schedule_work(&ndlc->sm_work);
265 int ndlc_probe(void *phy_id, struct nfc_phy_ops *phy_ops, struct device *dev,
266 int phy_headroom, int phy_tailroom, struct llt_ndlc **ndlc_id)
268 struct llt_ndlc *ndlc;
270 ndlc = devm_kzalloc(dev, sizeof(struct llt_ndlc), GFP_KERNEL);
275 ndlc->phy_id = phy_id;
281 /* initialize timers */
282 init_timer(&ndlc->t1_timer);
283 ndlc->t1_timer.data = (unsigned long)ndlc;
284 ndlc->t1_timer.function = ndlc_t1_timeout;
286 init_timer(&ndlc->t2_timer);
287 ndlc->t2_timer.data = (unsigned long)ndlc;
288 ndlc->t2_timer.function = ndlc_t2_timeout;
290 skb_queue_head_init(&ndlc->rcv_q);
291 skb_queue_head_init(&ndlc->send_q);
292 skb_queue_head_init(&ndlc->ack_pending_q);
294 INIT_WORK(&ndlc->sm_work, llt_ndlc_sm_work);
296 return st21nfcb_nci_probe(ndlc, phy_headroom, phy_tailroom);
298 EXPORT_SYMBOL(ndlc_probe);
300 void ndlc_remove(struct llt_ndlc *ndlc)
302 st21nfcb_nci_remove(ndlc->ndev);
305 del_timer_sync(&ndlc->t1_timer);
306 del_timer_sync(&ndlc->t2_timer);
307 ndlc->t2_active = false;
308 ndlc->t1_active = false;
310 skb_queue_purge(&ndlc->rcv_q);
311 skb_queue_purge(&ndlc->send_q);
313 EXPORT_SYMBOL(ndlc_remove);