1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) ST-Ericsson AB 2010
4 * Author: Sjur Brendeland
7 #define pr_fmt(fmt) KBUILD_MODNAME ":%s(): " fmt, __func__
9 #include <linux/stddef.h>
10 #include <linux/spinlock.h>
11 #include <linux/slab.h>
12 #include <linux/pkt_sched.h>
13 #include <net/caif/caif_layer.h>
14 #include <net/caif/cfpkt.h>
15 #include <net/caif/cfctrl.h>
17 #define container_obj(layr) container_of(layr, struct cfctrl, serv.layer)
18 #define UTILITY_NAME_LENGTH 16
19 #define CFPKT_CTRL_PKT_LEN 20
22 static int handle_loop(struct cfctrl *ctrl,
23 int cmd, struct cfpkt *pkt){
27 static int handle_loop(struct cfctrl *ctrl,
28 int cmd, struct cfpkt *pkt);
30 static int cfctrl_recv(struct cflayer *layr, struct cfpkt *pkt);
31 static void cfctrl_ctrlcmd(struct cflayer *layr, enum caif_ctrlcmd ctrl,
35 struct cflayer *cfctrl_create(void)
37 struct dev_info dev_info;
39 kzalloc(sizeof(struct cfctrl), GFP_ATOMIC);
42 caif_assert(offsetof(struct cfctrl, serv.layer) == 0);
43 memset(&dev_info, 0, sizeof(dev_info));
45 cfsrvl_init(&this->serv, 0, &dev_info, false);
46 atomic_set(&this->req_seq_no, 1);
47 atomic_set(&this->rsp_seq_no, 1);
48 this->serv.layer.receive = cfctrl_recv;
49 sprintf(this->serv.layer.name, "ctrl");
50 this->serv.layer.ctrlcmd = cfctrl_ctrlcmd;
52 spin_lock_init(&this->loop_linkid_lock);
53 this->loop_linkid = 1;
55 spin_lock_init(&this->info_list_lock);
56 INIT_LIST_HEAD(&this->list);
57 return &this->serv.layer;
60 void cfctrl_remove(struct cflayer *layer)
62 struct cfctrl_request_info *p, *tmp;
63 struct cfctrl *ctrl = container_obj(layer);
65 spin_lock_bh(&ctrl->info_list_lock);
66 list_for_each_entry_safe(p, tmp, &ctrl->list, list) {
70 spin_unlock_bh(&ctrl->info_list_lock);
74 static bool param_eq(const struct cfctrl_link_param *p1,
75 const struct cfctrl_link_param *p2)
78 p1->linktype == p2->linktype &&
79 p1->priority == p2->priority &&
80 p1->phyid == p2->phyid &&
81 p1->endpoint == p2->endpoint && p1->chtype == p2->chtype;
86 switch (p1->linktype) {
89 case CFCTRL_SRV_DATAGRAM:
90 return p1->u.datagram.connid == p2->u.datagram.connid;
93 p1->u.rfm.connid == p2->u.rfm.connid &&
94 strcmp(p1->u.rfm.volume, p2->u.rfm.volume) == 0;
97 p1->u.utility.fifosize_kb == p2->u.utility.fifosize_kb
98 && p1->u.utility.fifosize_bufs ==
99 p2->u.utility.fifosize_bufs
100 && strcmp(p1->u.utility.name, p2->u.utility.name) == 0
101 && p1->u.utility.paramlen == p2->u.utility.paramlen
102 && memcmp(p1->u.utility.params, p2->u.utility.params,
103 p1->u.utility.paramlen) == 0;
105 case CFCTRL_SRV_VIDEO:
106 return p1->u.video.connid == p2->u.video.connid;
109 case CFCTRL_SRV_DECM:
117 static bool cfctrl_req_eq(const struct cfctrl_request_info *r1,
118 const struct cfctrl_request_info *r2)
120 if (r1->cmd != r2->cmd)
122 if (r1->cmd == CFCTRL_CMD_LINK_SETUP)
123 return param_eq(&r1->param, &r2->param);
125 return r1->channel_id == r2->channel_id;
128 /* Insert request at the end */
129 static void cfctrl_insert_req(struct cfctrl *ctrl,
130 struct cfctrl_request_info *req)
132 spin_lock_bh(&ctrl->info_list_lock);
133 atomic_inc(&ctrl->req_seq_no);
134 req->sequence_no = atomic_read(&ctrl->req_seq_no);
135 list_add_tail(&req->list, &ctrl->list);
136 spin_unlock_bh(&ctrl->info_list_lock);
139 /* Compare and remove request */
140 static struct cfctrl_request_info *cfctrl_remove_req(struct cfctrl *ctrl,
141 struct cfctrl_request_info *req)
143 struct cfctrl_request_info *p, *tmp, *first;
145 first = list_first_entry(&ctrl->list, struct cfctrl_request_info, list);
147 list_for_each_entry_safe(p, tmp, &ctrl->list, list) {
148 if (cfctrl_req_eq(req, p)) {
150 pr_warn("Requests are not received in order\n");
152 atomic_set(&ctrl->rsp_seq_no,
163 struct cfctrl_rsp *cfctrl_get_respfuncs(struct cflayer *layer)
165 struct cfctrl *this = container_obj(layer);
169 static void init_info(struct caif_payload_info *info, struct cfctrl *cfctrl)
172 info->channel_id = cfctrl->serv.layer.id;
173 info->dev_info = &cfctrl->serv.dev_info;
176 void cfctrl_enum_req(struct cflayer *layer, u8 physlinkid)
179 struct cfctrl *cfctrl = container_obj(layer);
180 struct cflayer *dn = cfctrl->serv.layer.dn;
183 pr_debug("not able to send enum request\n");
186 pkt = cfpkt_create(CFPKT_CTRL_PKT_LEN);
189 caif_assert(offsetof(struct cfctrl, serv.layer) == 0);
190 init_info(cfpkt_info(pkt), cfctrl);
191 cfpkt_info(pkt)->dev_info->id = physlinkid;
192 cfctrl->serv.dev_info.id = physlinkid;
193 cfpkt_addbdy(pkt, CFCTRL_CMD_ENUM);
194 cfpkt_addbdy(pkt, physlinkid);
195 cfpkt_set_prio(pkt, TC_PRIO_CONTROL);
196 dn->transmit(dn, pkt);
199 int cfctrl_linkup_request(struct cflayer *layer,
200 struct cfctrl_link_param *param,
201 struct cflayer *user_layer)
203 struct cfctrl *cfctrl = container_obj(layer);
207 struct cfctrl_request_info *req;
209 char utility_name[16];
211 struct cflayer *dn = cfctrl->serv.layer.dn;
214 pr_debug("not able to send linkup request\n");
218 if (cfctrl_cancel_req(layer, user_layer) > 0) {
219 /* Slight Paranoia, check if already connecting */
220 pr_err("Duplicate connect request for same client\n");
225 pkt = cfpkt_create(CFPKT_CTRL_PKT_LEN);
228 cfpkt_addbdy(pkt, CFCTRL_CMD_LINK_SETUP);
229 cfpkt_addbdy(pkt, (param->chtype << 4) | param->linktype);
230 cfpkt_addbdy(pkt, (param->priority << 3) | param->phyid);
231 cfpkt_addbdy(pkt, param->endpoint & 0x03);
233 switch (param->linktype) {
236 case CFCTRL_SRV_VIDEO:
237 cfpkt_addbdy(pkt, (u8) param->u.video.connid);
241 case CFCTRL_SRV_DATAGRAM:
242 tmp32 = cpu_to_le32(param->u.datagram.connid);
243 cfpkt_add_body(pkt, &tmp32, 4);
246 /* Construct a frame, convert DatagramConnectionID to network
247 * format long and copy it out...
249 tmp32 = cpu_to_le32(param->u.rfm.connid);
250 cfpkt_add_body(pkt, &tmp32, 4);
251 /* Add volume name, including zero termination... */
252 cfpkt_add_body(pkt, param->u.rfm.volume,
253 strlen(param->u.rfm.volume) + 1);
255 case CFCTRL_SRV_UTIL:
256 tmp16 = cpu_to_le16(param->u.utility.fifosize_kb);
257 cfpkt_add_body(pkt, &tmp16, 2);
258 tmp16 = cpu_to_le16(param->u.utility.fifosize_bufs);
259 cfpkt_add_body(pkt, &tmp16, 2);
260 memset(utility_name, 0, sizeof(utility_name));
261 strscpy(utility_name, param->u.utility.name,
262 UTILITY_NAME_LENGTH);
263 cfpkt_add_body(pkt, utility_name, UTILITY_NAME_LENGTH);
264 tmp8 = param->u.utility.paramlen;
265 cfpkt_add_body(pkt, &tmp8, 1);
266 cfpkt_add_body(pkt, param->u.utility.params,
267 param->u.utility.paramlen);
270 pr_warn("Request setup of bad link type = %d\n",
275 req = kzalloc(sizeof(*req), GFP_KERNEL);
281 req->client_layer = user_layer;
282 req->cmd = CFCTRL_CMD_LINK_SETUP;
284 cfctrl_insert_req(cfctrl, req);
285 init_info(cfpkt_info(pkt), cfctrl);
287 * NOTE:Always send linkup and linkdown request on the same
288 * device as the payload. Otherwise old queued up payload
289 * might arrive with the newly allocated channel ID.
291 cfpkt_info(pkt)->dev_info->id = param->phyid;
292 cfpkt_set_prio(pkt, TC_PRIO_CONTROL);
294 dn->transmit(dn, pkt);
298 count = cfctrl_cancel_req(&cfctrl->serv.layer,
301 pr_err("Could not remove request (%d)", count);
308 int cfctrl_linkdown_req(struct cflayer *layer, u8 channelid,
309 struct cflayer *client)
313 struct cfctrl *cfctrl = container_obj(layer);
314 struct cflayer *dn = cfctrl->serv.layer.dn;
317 pr_debug("not able to send link-down request\n");
320 pkt = cfpkt_create(CFPKT_CTRL_PKT_LEN);
323 cfpkt_addbdy(pkt, CFCTRL_CMD_LINK_DESTROY);
324 cfpkt_addbdy(pkt, channelid);
325 init_info(cfpkt_info(pkt), cfctrl);
326 cfpkt_set_prio(pkt, TC_PRIO_CONTROL);
328 dn->transmit(dn, pkt);
330 cfctrl->loop_linkused[channelid] = 0;
335 int cfctrl_cancel_req(struct cflayer *layr, struct cflayer *adap_layer)
337 struct cfctrl_request_info *p, *tmp;
338 struct cfctrl *ctrl = container_obj(layr);
340 spin_lock_bh(&ctrl->info_list_lock);
342 list_for_each_entry_safe(p, tmp, &ctrl->list, list) {
343 if (p->client_layer == adap_layer) {
350 spin_unlock_bh(&ctrl->info_list_lock);
354 static int cfctrl_recv(struct cflayer *layer, struct cfpkt *pkt)
362 struct cfctrl *cfctrl = container_obj(layer);
363 struct cfctrl_request_info rsp, *req;
366 cmdrsp = cfpkt_extr_head_u8(pkt);
367 cmd = cmdrsp & CFCTRL_CMD_MASK;
368 if (cmd != CFCTRL_CMD_LINK_ERR
369 && CFCTRL_RSP_BIT != (CFCTRL_RSP_BIT & cmdrsp)
370 && CFCTRL_ERR_BIT != (CFCTRL_ERR_BIT & cmdrsp)) {
371 if (handle_loop(cfctrl, cmd, pkt) != 0)
372 cmdrsp |= CFCTRL_ERR_BIT;
376 case CFCTRL_CMD_LINK_SETUP:
378 enum cfctrl_srv serv;
379 enum cfctrl_srv servtype;
386 struct cfctrl_link_param linkparam;
387 memset(&linkparam, 0, sizeof(linkparam));
389 tmp = cfpkt_extr_head_u8(pkt);
391 serv = tmp & CFCTRL_SRV_MASK;
392 linkparam.linktype = serv;
395 linkparam.chtype = servtype;
397 tmp = cfpkt_extr_head_u8(pkt);
398 physlinkid = tmp & 0x07;
401 linkparam.priority = prio;
402 linkparam.phyid = physlinkid;
403 endpoint = cfpkt_extr_head_u8(pkt);
404 linkparam.endpoint = endpoint & 0x03;
409 if (CFCTRL_ERR_BIT & cmdrsp)
412 linkid = cfpkt_extr_head_u8(pkt);
414 case CFCTRL_SRV_VIDEO:
415 tmp = cfpkt_extr_head_u8(pkt);
416 linkparam.u.video.connid = tmp;
417 if (CFCTRL_ERR_BIT & cmdrsp)
420 linkid = cfpkt_extr_head_u8(pkt);
423 case CFCTRL_SRV_DATAGRAM:
424 linkparam.u.datagram.connid =
425 cfpkt_extr_head_u32(pkt);
426 if (CFCTRL_ERR_BIT & cmdrsp)
429 linkid = cfpkt_extr_head_u8(pkt);
432 /* Construct a frame, convert
433 * DatagramConnectionID
434 * to network format long and copy it out...
436 linkparam.u.rfm.connid =
437 cfpkt_extr_head_u32(pkt);
438 cp = (u8 *) linkparam.u.rfm.volume;
439 for (tmp = cfpkt_extr_head_u8(pkt);
440 cfpkt_more(pkt) && tmp != '\0';
441 tmp = cfpkt_extr_head_u8(pkt))
445 if (CFCTRL_ERR_BIT & cmdrsp)
448 linkid = cfpkt_extr_head_u8(pkt);
451 case CFCTRL_SRV_UTIL:
452 /* Construct a frame, convert
453 * DatagramConnectionID
454 * to network format long and copy it out...
457 linkparam.u.utility.fifosize_kb =
458 cfpkt_extr_head_u16(pkt);
460 linkparam.u.utility.fifosize_bufs =
461 cfpkt_extr_head_u16(pkt);
463 cp = (u8 *) linkparam.u.utility.name;
464 caif_assert(sizeof(linkparam.u.utility.name)
465 >= UTILITY_NAME_LENGTH);
467 i < UTILITY_NAME_LENGTH
468 && cfpkt_more(pkt); i++) {
469 tmp = cfpkt_extr_head_u8(pkt);
473 len = cfpkt_extr_head_u8(pkt);
474 linkparam.u.utility.paramlen = len;
476 cp = linkparam.u.utility.params;
477 while (cfpkt_more(pkt) && len--) {
478 tmp = cfpkt_extr_head_u8(pkt);
481 if (CFCTRL_ERR_BIT & cmdrsp)
484 linkid = cfpkt_extr_head_u8(pkt);
486 len = cfpkt_extr_head_u8(pkt);
488 cfpkt_extr_head(pkt, ¶m, len);
491 pr_warn("Request setup, invalid type (%d)\n",
497 rsp.param = linkparam;
498 spin_lock_bh(&cfctrl->info_list_lock);
499 req = cfctrl_remove_req(cfctrl, &rsp);
501 if (CFCTRL_ERR_BIT == (CFCTRL_ERR_BIT & cmdrsp) ||
502 cfpkt_erroneous(pkt)) {
503 pr_err("Invalid O/E bit or parse error "
504 "on CAIF control channel\n");
505 cfctrl->res.reject_rsp(cfctrl->serv.layer.up,
507 req ? req->client_layer
510 cfctrl->res.linksetup_rsp(cfctrl->serv.
514 client_layer : NULL);
519 spin_unlock_bh(&cfctrl->info_list_lock);
522 case CFCTRL_CMD_LINK_DESTROY:
523 linkid = cfpkt_extr_head_u8(pkt);
524 cfctrl->res.linkdestroy_rsp(cfctrl->serv.layer.up, linkid);
526 case CFCTRL_CMD_LINK_ERR:
527 pr_err("Frame Error Indication received\n");
528 cfctrl->res.linkerror_ind();
530 case CFCTRL_CMD_ENUM:
531 cfctrl->res.enum_rsp();
533 case CFCTRL_CMD_SLEEP:
534 cfctrl->res.sleep_rsp();
536 case CFCTRL_CMD_WAKE:
537 cfctrl->res.wake_rsp();
539 case CFCTRL_CMD_LINK_RECONF:
540 cfctrl->res.restart_rsp();
542 case CFCTRL_CMD_RADIO_SET:
543 cfctrl->res.radioset_rsp();
546 pr_err("Unrecognized Control Frame\n");
555 static void cfctrl_ctrlcmd(struct cflayer *layr, enum caif_ctrlcmd ctrl,
558 struct cfctrl *this = container_obj(layr);
560 case _CAIF_CTRLCMD_PHYIF_FLOW_OFF_IND:
561 case CAIF_CTRLCMD_FLOW_OFF_IND:
562 spin_lock_bh(&this->info_list_lock);
563 if (!list_empty(&this->list))
564 pr_debug("Received flow off in control layer\n");
565 spin_unlock_bh(&this->info_list_lock);
567 case _CAIF_CTRLCMD_PHYIF_DOWN_IND: {
568 struct cfctrl_request_info *p, *tmp;
570 /* Find all connect request and report failure */
571 spin_lock_bh(&this->info_list_lock);
572 list_for_each_entry_safe(p, tmp, &this->list, list) {
573 if (p->param.phyid == phyid) {
575 p->client_layer->ctrlcmd(p->client_layer,
576 CAIF_CTRLCMD_INIT_FAIL_RSP,
581 spin_unlock_bh(&this->info_list_lock);
590 static int handle_loop(struct cfctrl *ctrl, int cmd, struct cfpkt *pkt)
592 static int last_linkid;
594 u8 linkid, linktype, tmp;
596 case CFCTRL_CMD_LINK_SETUP:
597 spin_lock_bh(&ctrl->loop_linkid_lock);
599 for (linkid = last_linkid + 1; linkid < 254; linkid++)
600 if (!ctrl->loop_linkused[linkid])
604 for (linkid = last_linkid - 1; linkid > 1; linkid--)
605 if (!ctrl->loop_linkused[linkid])
607 spin_unlock_bh(&ctrl->loop_linkid_lock);
613 if (!ctrl->loop_linkused[linkid])
614 ctrl->loop_linkused[linkid] = 1;
616 last_linkid = linkid;
618 cfpkt_add_trail(pkt, &linkid, 1);
619 spin_unlock_bh(&ctrl->loop_linkid_lock);
620 cfpkt_peek_head(pkt, &linktype, 1);
621 if (linktype == CFCTRL_SRV_UTIL) {
623 cfpkt_add_trail(pkt, &tmp, 1);
624 cfpkt_add_trail(pkt, &tmp, 1);
628 case CFCTRL_CMD_LINK_DESTROY:
629 spin_lock_bh(&ctrl->loop_linkid_lock);
630 cfpkt_peek_head(pkt, &linkid, 1);
631 ctrl->loop_linkused[linkid] = 0;
632 spin_unlock_bh(&ctrl->loop_linkid_lock);