1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (c) 2016-2017, Linaro Ltd 4 */ 5 6 #include <linux/idr.h> 7 #include <linux/interrupt.h> 8 #include <linux/io.h> 9 #include <linux/list.h> 10 #include <linux/mfd/syscon.h> 11 #include <linux/module.h> 12 #include <linux/of.h> 13 #include <linux/of_address.h> 14 #include <linux/platform_device.h> 15 #include <linux/regmap.h> 16 #include <linux/rpmsg.h> 17 #include <linux/sizes.h> 18 #include <linux/slab.h> 19 #include <linux/wait.h> 20 #include <linux/workqueue.h> 21 #include <linux/mailbox_client.h> 22 23 #include "rpmsg_internal.h" 24 #include "qcom_glink_native.h" 25 26 #define CREATE_TRACE_POINTS 27 #include "qcom_glink_trace.h" 28 29 #define GLINK_NAME_SIZE 32 30 #define GLINK_VERSION_1 1 31 32 #define RPM_GLINK_CID_MIN 1 33 #define RPM_GLINK_CID_MAX 65536 34 35 struct glink_msg { 36 /* New members MUST be added within the __struct_group() macro below. */ 37 __struct_group(glink_msg_hdr, hdr, __packed, 38 __le16 cmd; 39 __le16 param1; 40 __le32 param2; 41 ); 42 u8 data[]; 43 } __packed; 44 static_assert(offsetof(struct glink_msg, data) == sizeof(struct glink_msg_hdr), 45 "struct member likely outside of __struct_group()"); 46 47 /** 48 * struct glink_defer_cmd - deferred incoming control message 49 * @node: list node 50 * @msg: message header 51 * @data: payload of the message 52 * 53 * Copy of a received control message, to be added to @rx_queue and processed 54 * by @rx_work of @qcom_glink. 55 */ 56 struct glink_defer_cmd { 57 struct list_head node; 58 59 struct glink_msg_hdr msg; 60 u8 data[]; 61 }; 62 63 /** 64 * struct glink_core_rx_intent - RX intent 65 * RX intent 66 * 67 * @data: pointer to the data (may be NULL for zero-copy) 68 * @id: remote or local intent ID 69 * @size: size of the original intent (do not modify) 70 * @reuse: To mark if the intent can be reused after first use 71 * @in_use: To mark if intent is already in use for the channel 72 * @offset: next write offset (initially 0) 73 * @node: list node 74 */ 75 struct glink_core_rx_intent { 76 void *data; 77 u32 id; 78 size_t size; 79 bool reuse; 80 bool in_use; 81 u32 offset; 82 83 struct list_head node; 84 }; 85 86 /** 87 * struct qcom_glink - driver context, relates to one remote subsystem 88 * @dev: reference to the associated struct device 89 * @label: identifier of the glink edge 90 * @rx_pipe: pipe object for receive FIFO 91 * @tx_pipe: pipe object for transmit FIFO 92 * @rx_work: worker for handling received control messages 93 * @rx_lock: protects the @rx_queue 94 * @rx_queue: queue of received control messages to be processed in @rx_work 95 * @tx_lock: synchronizes operations on the tx fifo 96 * @idr_lock: synchronizes @lcids and @rcids modifications 97 * @lcids: idr of all channels with a known local channel id 98 * @rcids: idr of all channels with a known remote channel id 99 * @features: remote features 100 * @intentless: flag to indicate that there is no intent 101 * @tx_avail_notify: Waitqueue for pending tx tasks 102 * @sent_read_notify: flag to check cmd sent or not 103 * @abort_tx: flag indicating that all tx attempts should fail 104 */ 105 struct qcom_glink { 106 struct device *dev; 107 108 const char *label; 109 110 struct qcom_glink_pipe *rx_pipe; 111 struct qcom_glink_pipe *tx_pipe; 112 113 struct work_struct rx_work; 114 spinlock_t rx_lock; 115 struct list_head rx_queue; 116 117 spinlock_t tx_lock; 118 119 spinlock_t idr_lock; 120 struct idr lcids; 121 struct idr rcids; 122 unsigned long features; 123 124 bool intentless; 125 wait_queue_head_t tx_avail_notify; 126 bool sent_read_notify; 127 128 bool abort_tx; 129 }; 130 131 enum { 132 GLINK_STATE_CLOSED, 133 GLINK_STATE_OPENING, 134 GLINK_STATE_OPEN, 135 GLINK_STATE_CLOSING, 136 }; 137 138 /** 139 * struct glink_channel - internal representation of a channel 140 * @rpdev: rpdev reference, only used for primary endpoints 141 * @ept: rpmsg endpoint this channel is associated with 142 * @glink: qcom_glink context handle 143 * @refcount: refcount for the channel object 144 * @recv_lock: guard for @ept.cb 145 * @name: unique channel name/identifier 146 * @lcid: channel id, in local space 147 * @rcid: channel id, in remote space 148 * @intent_lock: lock for protection of @liids, @riids 149 * @liids: idr of all local intents 150 * @riids: idr of all remote intents 151 * @intent_work: worker responsible for transmitting rx_done packets 152 * @done_intents: list of intents that needs to be announced rx_done 153 * @buf: receive buffer, for gathering fragments 154 * @buf_offset: write offset in @buf 155 * @buf_size: size of current @buf 156 * @open_ack: completed once remote has acked the open-request 157 * @open_req: completed once open-request has been received 158 * @intent_req_lock: Synchronises multiple intent requests 159 * @intent_req_result: Result of intent request 160 * @intent_received: flag indicating that an intent has been received 161 * @intent_req_wq: wait queue for intent_req signalling 162 */ 163 struct glink_channel { 164 struct rpmsg_endpoint ept; 165 166 struct rpmsg_device *rpdev; 167 struct qcom_glink *glink; 168 169 struct kref refcount; 170 171 spinlock_t recv_lock; 172 173 char *name; 174 unsigned int lcid; 175 unsigned int rcid; 176 177 spinlock_t intent_lock; 178 struct idr liids; 179 struct idr riids; 180 struct work_struct intent_work; 181 struct list_head done_intents; 182 183 struct glink_core_rx_intent *buf; 184 int buf_offset; 185 int buf_size; 186 187 struct completion open_ack; 188 struct completion open_req; 189 190 struct mutex intent_req_lock; 191 int intent_req_result; 192 bool intent_received; 193 wait_queue_head_t intent_req_wq; 194 }; 195 196 #define to_glink_channel(_ept) container_of(_ept, struct glink_channel, ept) 197 198 static const struct rpmsg_endpoint_ops glink_endpoint_ops; 199 200 #define GLINK_CMD_VERSION 0 201 #define GLINK_CMD_VERSION_ACK 1 202 #define GLINK_CMD_OPEN 2 203 #define GLINK_CMD_CLOSE 3 204 #define GLINK_CMD_OPEN_ACK 4 205 #define GLINK_CMD_INTENT 5 206 #define GLINK_CMD_RX_DONE 6 207 #define GLINK_CMD_RX_INTENT_REQ 7 208 #define GLINK_CMD_RX_INTENT_REQ_ACK 8 209 #define GLINK_CMD_TX_DATA 9 210 #define GLINK_CMD_CLOSE_ACK 11 211 #define GLINK_CMD_TX_DATA_CONT 12 212 #define GLINK_CMD_READ_NOTIF 13 213 #define GLINK_CMD_RX_DONE_W_REUSE 14 214 #define GLINK_CMD_SIGNALS 15 215 216 #define GLINK_FEATURE_INTENTLESS BIT(1) 217 218 #define NATIVE_DTR_SIG NATIVE_DSR_SIG 219 #define NATIVE_DSR_SIG BIT(31) 220 #define NATIVE_RTS_SIG NATIVE_CTS_SIG 221 #define NATIVE_CTS_SIG BIT(30) 222 223 static void qcom_glink_rx_done_work(struct work_struct *work); 224 225 static struct glink_channel *qcom_glink_alloc_channel(struct qcom_glink *glink, 226 const char *name) 227 { 228 struct glink_channel *channel; 229 230 channel = kzalloc(sizeof(*channel), GFP_KERNEL); 231 if (!channel) 232 return ERR_PTR(-ENOMEM); 233 234 /* Setup glink internal glink_channel data */ 235 spin_lock_init(&channel->recv_lock); 236 spin_lock_init(&channel->intent_lock); 237 mutex_init(&channel->intent_req_lock); 238 239 channel->glink = glink; 240 channel->name = kstrdup(name, GFP_KERNEL); 241 if (!channel->name) { 242 kfree(channel); 243 return ERR_PTR(-ENOMEM); 244 } 245 246 init_completion(&channel->open_req); 247 init_completion(&channel->open_ack); 248 init_waitqueue_head(&channel->intent_req_wq); 249 250 INIT_LIST_HEAD(&channel->done_intents); 251 INIT_WORK(&channel->intent_work, qcom_glink_rx_done_work); 252 253 idr_init(&channel->liids); 254 idr_init(&channel->riids); 255 kref_init(&channel->refcount); 256 257 return channel; 258 } 259 260 static void qcom_glink_channel_release(struct kref *ref) 261 { 262 struct glink_channel *channel = container_of(ref, struct glink_channel, 263 refcount); 264 struct glink_core_rx_intent *intent; 265 struct glink_core_rx_intent *tmp; 266 unsigned long flags; 267 int iid; 268 269 /* cancel pending rx_done work */ 270 cancel_work_sync(&channel->intent_work); 271 272 spin_lock_irqsave(&channel->intent_lock, flags); 273 /* Free all non-reuse intents pending rx_done work */ 274 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) { 275 if (!intent->reuse) { 276 kfree(intent->data); 277 kfree(intent); 278 } 279 } 280 281 idr_for_each_entry(&channel->liids, tmp, iid) { 282 kfree(tmp->data); 283 kfree(tmp); 284 } 285 idr_destroy(&channel->liids); 286 287 idr_for_each_entry(&channel->riids, tmp, iid) 288 kfree(tmp); 289 idr_destroy(&channel->riids); 290 spin_unlock_irqrestore(&channel->intent_lock, flags); 291 292 kfree(channel->name); 293 kfree(channel); 294 } 295 296 static size_t qcom_glink_rx_avail(struct qcom_glink *glink) 297 { 298 return glink->rx_pipe->avail(glink->rx_pipe); 299 } 300 301 static void qcom_glink_rx_peek(struct qcom_glink *glink, 302 void *data, unsigned int offset, size_t count) 303 { 304 glink->rx_pipe->peek(glink->rx_pipe, data, offset, count); 305 } 306 307 static void qcom_glink_rx_advance(struct qcom_glink *glink, size_t count) 308 { 309 glink->rx_pipe->advance(glink->rx_pipe, count); 310 } 311 312 static size_t qcom_glink_tx_avail(struct qcom_glink *glink) 313 { 314 return glink->tx_pipe->avail(glink->tx_pipe); 315 } 316 317 static void qcom_glink_tx_write(struct qcom_glink *glink, 318 const void *hdr, size_t hlen, 319 const void *data, size_t dlen) 320 { 321 glink->tx_pipe->write(glink->tx_pipe, hdr, hlen, data, dlen); 322 } 323 324 static void qcom_glink_tx_kick(struct qcom_glink *glink) 325 { 326 glink->tx_pipe->kick(glink->tx_pipe); 327 } 328 329 static void qcom_glink_send_read_notify(struct qcom_glink *glink) 330 { 331 struct glink_msg msg; 332 333 msg.cmd = cpu_to_le16(GLINK_CMD_READ_NOTIF); 334 msg.param1 = 0; 335 msg.param2 = 0; 336 337 qcom_glink_tx_write(glink, &msg, sizeof(msg), NULL, 0); 338 339 qcom_glink_tx_kick(glink); 340 } 341 342 static int qcom_glink_tx(struct qcom_glink *glink, 343 const void *hdr, size_t hlen, 344 const void *data, size_t dlen, bool wait) 345 { 346 unsigned int tlen = hlen + dlen; 347 unsigned long flags; 348 int ret = 0; 349 350 /* Reject packets that are too big */ 351 if (tlen >= glink->tx_pipe->length) 352 return -EINVAL; 353 354 spin_lock_irqsave(&glink->tx_lock, flags); 355 356 if (glink->abort_tx) { 357 ret = -EIO; 358 goto out; 359 } 360 361 while (qcom_glink_tx_avail(glink) < tlen) { 362 if (!wait) { 363 ret = -EAGAIN; 364 goto out; 365 } 366 367 if (glink->abort_tx) { 368 ret = -EIO; 369 goto out; 370 } 371 372 if (!glink->sent_read_notify) { 373 glink->sent_read_notify = true; 374 qcom_glink_send_read_notify(glink); 375 } 376 377 /* Wait without holding the tx_lock */ 378 spin_unlock_irqrestore(&glink->tx_lock, flags); 379 380 wait_event_timeout(glink->tx_avail_notify, 381 qcom_glink_tx_avail(glink) >= tlen, 10 * HZ); 382 383 spin_lock_irqsave(&glink->tx_lock, flags); 384 385 if (qcom_glink_tx_avail(glink) >= tlen) 386 glink->sent_read_notify = false; 387 } 388 389 qcom_glink_tx_write(glink, hdr, hlen, data, dlen); 390 qcom_glink_tx_kick(glink); 391 392 out: 393 spin_unlock_irqrestore(&glink->tx_lock, flags); 394 395 return ret; 396 } 397 398 static int qcom_glink_send_version(struct qcom_glink *glink) 399 { 400 struct glink_msg msg; 401 402 msg.cmd = cpu_to_le16(GLINK_CMD_VERSION); 403 msg.param1 = cpu_to_le16(GLINK_VERSION_1); 404 msg.param2 = cpu_to_le32(glink->features); 405 406 trace_qcom_glink_cmd_version_tx(glink->label, GLINK_VERSION_1, glink->features); 407 408 return qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true); 409 } 410 411 static void qcom_glink_send_version_ack(struct qcom_glink *glink) 412 { 413 struct glink_msg msg; 414 415 msg.cmd = cpu_to_le16(GLINK_CMD_VERSION_ACK); 416 msg.param1 = cpu_to_le16(GLINK_VERSION_1); 417 msg.param2 = cpu_to_le32(glink->features); 418 419 trace_qcom_glink_cmd_version_ack_tx(glink->label, msg.param1, msg.param2); 420 421 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true); 422 } 423 424 static void qcom_glink_send_open_ack(struct qcom_glink *glink, 425 struct glink_channel *channel) 426 { 427 struct glink_msg msg; 428 429 msg.cmd = cpu_to_le16(GLINK_CMD_OPEN_ACK); 430 msg.param1 = cpu_to_le16(channel->rcid); 431 msg.param2 = cpu_to_le32(0); 432 433 trace_qcom_glink_cmd_open_ack_tx(glink->label, channel->name, 434 channel->lcid, channel->rcid); 435 436 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true); 437 } 438 439 static void qcom_glink_handle_intent_req_ack(struct qcom_glink *glink, 440 unsigned int cid, bool granted) 441 { 442 struct glink_channel *channel; 443 unsigned long flags; 444 445 qcom_glink_rx_advance(glink, ALIGN(sizeof(struct glink_msg), 8)); 446 447 spin_lock_irqsave(&glink->idr_lock, flags); 448 channel = idr_find(&glink->rcids, cid); 449 spin_unlock_irqrestore(&glink->idr_lock, flags); 450 451 trace_qcom_glink_cmd_rx_intent_req_ack_rx(glink->label, 452 channel ? channel->name : NULL, 453 channel ? channel->lcid : 0, 454 cid, granted); 455 if (!channel) { 456 dev_err(glink->dev, "unable to find channel\n"); 457 return; 458 } 459 460 WRITE_ONCE(channel->intent_req_result, granted); 461 wake_up_all(&channel->intent_req_wq); 462 } 463 464 static void qcom_glink_intent_req_abort(struct glink_channel *channel) 465 { 466 WRITE_ONCE(channel->intent_req_result, 0); 467 wake_up_all(&channel->intent_req_wq); 468 } 469 470 /** 471 * qcom_glink_send_open_req() - send a GLINK_CMD_OPEN request to the remote 472 * @glink: Ptr to the glink edge 473 * @channel: Ptr to the channel that the open req is sent 474 * 475 * Allocates a local channel id and sends a GLINK_CMD_OPEN message to the remote. 476 * Will return with refcount held, regardless of outcome. 477 * 478 * Return: 0 on success, negative errno otherwise. 479 */ 480 static int qcom_glink_send_open_req(struct qcom_glink *glink, 481 struct glink_channel *channel) 482 { 483 DEFINE_RAW_FLEX(struct glink_msg, req, data, GLINK_NAME_SIZE); 484 int name_len = strlen(channel->name) + 1; 485 int req_len = ALIGN(sizeof(*req) + name_len, 8); 486 int ret; 487 unsigned long flags; 488 489 kref_get(&channel->refcount); 490 491 spin_lock_irqsave(&glink->idr_lock, flags); 492 ret = idr_alloc_cyclic(&glink->lcids, channel, 493 RPM_GLINK_CID_MIN, RPM_GLINK_CID_MAX, 494 GFP_ATOMIC); 495 spin_unlock_irqrestore(&glink->idr_lock, flags); 496 if (ret < 0) 497 return ret; 498 499 channel->lcid = ret; 500 501 req->cmd = cpu_to_le16(GLINK_CMD_OPEN); 502 req->param1 = cpu_to_le16(channel->lcid); 503 req->param2 = cpu_to_le32(name_len); 504 strcpy(req->data, channel->name); 505 506 trace_qcom_glink_cmd_open_tx(glink->label, channel->name, 507 channel->lcid, channel->rcid); 508 509 ret = qcom_glink_tx(glink, req, req_len, NULL, 0, true); 510 if (ret) 511 goto remove_idr; 512 513 return 0; 514 515 remove_idr: 516 spin_lock_irqsave(&glink->idr_lock, flags); 517 idr_remove(&glink->lcids, channel->lcid); 518 channel->lcid = 0; 519 spin_unlock_irqrestore(&glink->idr_lock, flags); 520 521 return ret; 522 } 523 524 static void qcom_glink_send_close_req(struct qcom_glink *glink, 525 struct glink_channel *channel) 526 { 527 struct glink_msg req; 528 529 req.cmd = cpu_to_le16(GLINK_CMD_CLOSE); 530 req.param1 = cpu_to_le16(channel->lcid); 531 req.param2 = 0; 532 533 trace_qcom_glink_cmd_close_tx(glink->label, channel->name, 534 channel->lcid, channel->rcid); 535 536 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true); 537 } 538 539 static void qcom_glink_send_close_ack(struct qcom_glink *glink, 540 struct glink_channel *channel) 541 { 542 struct glink_msg req; 543 544 req.cmd = cpu_to_le16(GLINK_CMD_CLOSE_ACK); 545 req.param1 = cpu_to_le16(channel->rcid); 546 req.param2 = 0; 547 548 trace_qcom_glink_cmd_close_ack_tx(glink->label, channel->name, 549 channel->lcid, channel->rcid); 550 551 qcom_glink_tx(glink, &req, sizeof(req), NULL, 0, true); 552 } 553 554 static void qcom_glink_rx_done_work(struct work_struct *work) 555 { 556 struct glink_channel *channel = container_of(work, struct glink_channel, 557 intent_work); 558 struct qcom_glink *glink = channel->glink; 559 struct glink_core_rx_intent *intent, *tmp; 560 struct { 561 u16 id; 562 u16 lcid; 563 u32 liid; 564 } __packed cmd; 565 566 unsigned int cid = channel->lcid; 567 unsigned int iid; 568 bool reuse; 569 unsigned long flags; 570 571 spin_lock_irqsave(&channel->intent_lock, flags); 572 list_for_each_entry_safe(intent, tmp, &channel->done_intents, node) { 573 list_del(&intent->node); 574 spin_unlock_irqrestore(&channel->intent_lock, flags); 575 iid = intent->id; 576 reuse = intent->reuse; 577 578 cmd.id = reuse ? GLINK_CMD_RX_DONE_W_REUSE : GLINK_CMD_RX_DONE; 579 cmd.lcid = cid; 580 cmd.liid = iid; 581 582 trace_qcom_glink_cmd_rx_done_tx(glink->label, channel->name, 583 channel->lcid, channel->rcid, cmd.liid, reuse); 584 585 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true); 586 if (!reuse) { 587 kfree(intent->data); 588 kfree(intent); 589 } 590 spin_lock_irqsave(&channel->intent_lock, flags); 591 } 592 spin_unlock_irqrestore(&channel->intent_lock, flags); 593 } 594 595 static void qcom_glink_rx_done(struct qcom_glink *glink, 596 struct glink_channel *channel, 597 struct glink_core_rx_intent *intent) 598 { 599 /* We don't send RX_DONE to intentless systems */ 600 if (glink->intentless) { 601 kfree(intent->data); 602 kfree(intent); 603 return; 604 } 605 606 /* Take it off the tree of receive intents */ 607 if (!intent->reuse) { 608 spin_lock(&channel->intent_lock); 609 idr_remove(&channel->liids, intent->id); 610 spin_unlock(&channel->intent_lock); 611 } 612 613 /* Schedule the sending of a rx_done indication */ 614 spin_lock(&channel->intent_lock); 615 list_add_tail(&intent->node, &channel->done_intents); 616 spin_unlock(&channel->intent_lock); 617 618 schedule_work(&channel->intent_work); 619 } 620 621 /** 622 * qcom_glink_receive_version() - receive version/features from remote system 623 * 624 * @glink: pointer to transport interface 625 * @version: remote version 626 * @features: remote features 627 * 628 * This function is called in response to a remote-initiated version/feature 629 * negotiation sequence. 630 */ 631 static void qcom_glink_receive_version(struct qcom_glink *glink, 632 u32 version, 633 u32 features) 634 { 635 trace_qcom_glink_cmd_version_rx(glink->label, version, features); 636 637 switch (version) { 638 case 0: 639 break; 640 case GLINK_VERSION_1: 641 glink->features &= features; 642 fallthrough; 643 default: 644 qcom_glink_send_version_ack(glink); 645 break; 646 } 647 } 648 649 /** 650 * qcom_glink_receive_version_ack() - receive negotiation ack from remote system 651 * 652 * @glink: pointer to transport interface 653 * @version: remote version response 654 * @features: remote features response 655 * 656 * This function is called in response to a local-initiated version/feature 657 * negotiation sequence and is the counter-offer from the remote side based 658 * upon the initial version and feature set requested. 659 */ 660 static void qcom_glink_receive_version_ack(struct qcom_glink *glink, 661 u32 version, 662 u32 features) 663 { 664 trace_qcom_glink_cmd_version_ack_rx(glink->label, version, features); 665 666 switch (version) { 667 case 0: 668 /* Version negotiation failed */ 669 break; 670 case GLINK_VERSION_1: 671 if (features == glink->features) 672 break; 673 674 glink->features &= features; 675 fallthrough; 676 default: 677 qcom_glink_send_version(glink); 678 break; 679 } 680 } 681 682 /** 683 * qcom_glink_send_intent_req_ack() - convert an rx intent request ack cmd to 684 * wire format and transmit 685 * @glink: The transport to transmit on. 686 * @channel: The glink channel 687 * @granted: The request response to encode. 688 * 689 * Return: 0 on success or standard Linux error code. 690 */ 691 static int qcom_glink_send_intent_req_ack(struct qcom_glink *glink, 692 struct glink_channel *channel, 693 bool granted) 694 { 695 struct glink_msg msg; 696 697 trace_qcom_glink_cmd_rx_intent_req_ack_tx(glink->label, channel->name, 698 channel->lcid, channel->rcid, 699 granted); 700 701 msg.cmd = cpu_to_le16(GLINK_CMD_RX_INTENT_REQ_ACK); 702 msg.param1 = cpu_to_le16(channel->lcid); 703 msg.param2 = cpu_to_le32(granted); 704 705 qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true); 706 707 return 0; 708 } 709 710 /** 711 * qcom_glink_advertise_intent - convert an rx intent cmd to wire format and 712 * transmit 713 * @glink: The transport to transmit on. 714 * @channel: The local channel 715 * @intent: The intent to pass on to remote. 716 * 717 * Return: 0 on success or standard Linux error code. 718 */ 719 static int qcom_glink_advertise_intent(struct qcom_glink *glink, 720 struct glink_channel *channel, 721 struct glink_core_rx_intent *intent) 722 { 723 struct command { 724 __le16 id; 725 __le16 lcid; 726 __le32 count; 727 __le32 size; 728 __le32 liid; 729 } __packed; 730 struct command cmd; 731 732 cmd.id = cpu_to_le16(GLINK_CMD_INTENT); 733 cmd.lcid = cpu_to_le16(channel->lcid); 734 cmd.count = cpu_to_le32(1); 735 cmd.size = cpu_to_le32(intent->size); 736 cmd.liid = cpu_to_le32(intent->id); 737 738 trace_qcom_glink_cmd_intent_tx(glink->label, channel->name, 739 channel->lcid, channel->rcid, 740 cmd.count, cmd.size, cmd.liid); 741 742 qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true); 743 744 return 0; 745 } 746 747 static struct glink_core_rx_intent * 748 qcom_glink_alloc_intent(struct qcom_glink *glink, 749 struct glink_channel *channel, 750 size_t size, 751 bool reuseable) 752 { 753 struct glink_core_rx_intent *intent; 754 int ret; 755 unsigned long flags; 756 757 intent = kzalloc(sizeof(*intent), GFP_KERNEL); 758 if (!intent) 759 return NULL; 760 761 intent->data = kzalloc(size, GFP_KERNEL); 762 if (!intent->data) 763 goto free_intent; 764 765 spin_lock_irqsave(&channel->intent_lock, flags); 766 ret = idr_alloc_cyclic(&channel->liids, intent, 1, -1, GFP_ATOMIC); 767 if (ret < 0) { 768 spin_unlock_irqrestore(&channel->intent_lock, flags); 769 goto free_data; 770 } 771 spin_unlock_irqrestore(&channel->intent_lock, flags); 772 773 intent->id = ret; 774 intent->size = size; 775 intent->reuse = reuseable; 776 777 return intent; 778 779 free_data: 780 kfree(intent->data); 781 free_intent: 782 kfree(intent); 783 return NULL; 784 } 785 786 static void qcom_glink_handle_rx_done(struct qcom_glink *glink, 787 u32 cid, uint32_t iid, 788 bool reuse) 789 { 790 struct glink_core_rx_intent *intent; 791 struct glink_channel *channel; 792 unsigned long flags; 793 794 qcom_glink_rx_advance(glink, ALIGN(sizeof(struct glink_msg), 8)); 795 796 spin_lock_irqsave(&glink->idr_lock, flags); 797 channel = idr_find(&glink->rcids, cid); 798 spin_unlock_irqrestore(&glink->idr_lock, flags); 799 800 trace_qcom_glink_cmd_rx_done_rx(glink->label, channel ? channel->name : NULL, 801 channel ? channel->lcid : 0, cid, iid, reuse); 802 if (!channel) { 803 dev_err(glink->dev, "invalid channel id received\n"); 804 return; 805 } 806 807 spin_lock_irqsave(&channel->intent_lock, flags); 808 intent = idr_find(&channel->riids, iid); 809 810 if (!intent) { 811 spin_unlock_irqrestore(&channel->intent_lock, flags); 812 dev_err(glink->dev, "invalid intent id received\n"); 813 return; 814 } 815 816 intent->in_use = false; 817 818 if (!reuse) { 819 idr_remove(&channel->riids, intent->id); 820 kfree(intent); 821 } 822 spin_unlock_irqrestore(&channel->intent_lock, flags); 823 824 if (reuse) { 825 WRITE_ONCE(channel->intent_received, true); 826 wake_up_all(&channel->intent_req_wq); 827 } 828 } 829 830 /** 831 * qcom_glink_handle_intent_req() - Receive a request for rx_intent 832 * from remote side 833 * @glink: Pointer to the transport interface 834 * @cid: Remote channel ID 835 * @size: size of the intent 836 * 837 * The function searches for the local channel to which the request for 838 * rx_intent has arrived and allocates and notifies the remote back 839 */ 840 static void qcom_glink_handle_intent_req(struct qcom_glink *glink, 841 u32 cid, size_t size) 842 { 843 struct glink_core_rx_intent *intent; 844 struct glink_channel *channel; 845 unsigned long flags; 846 847 spin_lock_irqsave(&glink->idr_lock, flags); 848 channel = idr_find(&glink->rcids, cid); 849 spin_unlock_irqrestore(&glink->idr_lock, flags); 850 851 trace_qcom_glink_cmd_rx_intent_req_rx(glink->label, 852 channel ? channel->name : NULL, 853 channel ? channel->lcid : 0, 854 cid, size); 855 if (!channel) { 856 pr_err("%s channel not found for cid %d\n", __func__, cid); 857 return; 858 } 859 860 intent = qcom_glink_alloc_intent(glink, channel, size, false); 861 if (intent) 862 qcom_glink_advertise_intent(glink, channel, intent); 863 864 qcom_glink_send_intent_req_ack(glink, channel, !!intent); 865 } 866 867 static int qcom_glink_rx_defer(struct qcom_glink *glink, size_t extra) 868 { 869 struct glink_defer_cmd *dcmd; 870 871 extra = ALIGN(extra, 8); 872 873 if (qcom_glink_rx_avail(glink) < sizeof(struct glink_msg) + extra) { 874 dev_dbg(glink->dev, "Insufficient data in rx fifo"); 875 return -ENXIO; 876 } 877 878 dcmd = kzalloc(struct_size(dcmd, data, extra), GFP_ATOMIC); 879 if (!dcmd) 880 return -ENOMEM; 881 882 INIT_LIST_HEAD(&dcmd->node); 883 884 qcom_glink_rx_peek(glink, 885 container_of(&dcmd->msg, struct glink_msg, hdr), 0, 886 sizeof(dcmd->msg) + extra); 887 888 spin_lock(&glink->rx_lock); 889 list_add_tail(&dcmd->node, &glink->rx_queue); 890 spin_unlock(&glink->rx_lock); 891 892 schedule_work(&glink->rx_work); 893 qcom_glink_rx_advance(glink, sizeof(dcmd->msg) + extra); 894 895 return 0; 896 } 897 898 static int qcom_glink_rx_data(struct qcom_glink *glink, size_t avail) 899 { 900 struct glink_core_rx_intent *intent; 901 struct glink_channel *channel; 902 struct { 903 struct glink_msg_hdr msg; 904 __le32 chunk_size; 905 __le32 left_size; 906 } __packed hdr; 907 unsigned int chunk_size; 908 unsigned int left_size; 909 unsigned int rcid; 910 unsigned int liid; 911 int ret = 0; 912 unsigned long flags; 913 914 if (avail < sizeof(hdr)) { 915 dev_dbg(glink->dev, "Not enough data in fifo\n"); 916 return -EAGAIN; 917 } 918 919 qcom_glink_rx_peek(glink, &hdr, 0, sizeof(hdr)); 920 chunk_size = le32_to_cpu(hdr.chunk_size); 921 left_size = le32_to_cpu(hdr.left_size); 922 923 if (avail < sizeof(hdr) + chunk_size) { 924 dev_dbg(glink->dev, "Payload not yet in fifo\n"); 925 return -EAGAIN; 926 } 927 928 rcid = le16_to_cpu(hdr.msg.param1); 929 liid = le32_to_cpu(hdr.msg.param2); 930 spin_lock_irqsave(&glink->idr_lock, flags); 931 channel = idr_find(&glink->rcids, rcid); 932 spin_unlock_irqrestore(&glink->idr_lock, flags); 933 934 trace_qcom_glink_cmd_tx_data_rx(glink->label, channel ? channel->name : NULL, 935 channel ? channel->lcid : 0, rcid, 936 liid, chunk_size, left_size, 937 hdr.msg.cmd == GLINK_CMD_TX_DATA_CONT); 938 if (!channel) { 939 dev_dbg(glink->dev, "Data on non-existing channel\n"); 940 941 /* Drop the message */ 942 goto advance_rx; 943 } 944 945 if (glink->intentless) { 946 /* Might have an ongoing, fragmented, message to append */ 947 if (!channel->buf) { 948 intent = kzalloc(sizeof(*intent), GFP_ATOMIC); 949 if (!intent) 950 return -ENOMEM; 951 952 intent->data = kmalloc(chunk_size + left_size, 953 GFP_ATOMIC); 954 if (!intent->data) { 955 kfree(intent); 956 return -ENOMEM; 957 } 958 959 intent->id = 0xbabababa; 960 intent->size = chunk_size + left_size; 961 intent->offset = 0; 962 963 channel->buf = intent; 964 } else { 965 intent = channel->buf; 966 } 967 } else { 968 spin_lock_irqsave(&channel->intent_lock, flags); 969 intent = idr_find(&channel->liids, liid); 970 spin_unlock_irqrestore(&channel->intent_lock, flags); 971 972 if (!intent) { 973 dev_err(glink->dev, 974 "no intent found for channel %s intent %d", 975 channel->name, liid); 976 ret = -ENOENT; 977 goto advance_rx; 978 } 979 } 980 981 if (intent->size - intent->offset < chunk_size) { 982 dev_err(glink->dev, "Insufficient space in intent\n"); 983 984 /* The packet header lied, drop payload */ 985 goto advance_rx; 986 } 987 988 qcom_glink_rx_peek(glink, intent->data + intent->offset, 989 sizeof(hdr), chunk_size); 990 intent->offset += chunk_size; 991 992 /* Handle message when no fragments remain to be received */ 993 if (!left_size) { 994 spin_lock(&channel->recv_lock); 995 if (channel->ept.cb) { 996 channel->ept.cb(channel->ept.rpdev, 997 intent->data, 998 intent->offset, 999 channel->ept.priv, 1000 RPMSG_ADDR_ANY); 1001 } 1002 spin_unlock(&channel->recv_lock); 1003 1004 intent->offset = 0; 1005 channel->buf = NULL; 1006 1007 qcom_glink_rx_done(glink, channel, intent); 1008 } 1009 1010 advance_rx: 1011 qcom_glink_rx_advance(glink, ALIGN(sizeof(hdr) + chunk_size, 8)); 1012 1013 return ret; 1014 } 1015 1016 static void qcom_glink_rx_read_notif(struct qcom_glink *glink) 1017 { 1018 trace_qcom_glink_cmd_read_notif_rx(glink->label); 1019 1020 qcom_glink_rx_advance(glink, ALIGN(sizeof(struct glink_msg), 8)); 1021 qcom_glink_tx_kick(glink); 1022 } 1023 1024 static void qcom_glink_handle_intent(struct qcom_glink *glink, 1025 unsigned int cid, 1026 unsigned int count, 1027 size_t avail) 1028 { 1029 struct glink_core_rx_intent *intent; 1030 struct glink_channel *channel; 1031 struct intent_pair { 1032 __le32 size; 1033 __le32 iid; 1034 }; 1035 1036 struct { 1037 struct glink_msg_hdr msg; 1038 struct intent_pair intents[]; 1039 } __packed * msg; 1040 1041 const size_t msglen = struct_size(msg, intents, count); 1042 int ret; 1043 int i; 1044 unsigned long flags; 1045 1046 if (avail < msglen) { 1047 dev_dbg(glink->dev, "Not enough data in fifo\n"); 1048 return; 1049 } 1050 1051 spin_lock_irqsave(&glink->idr_lock, flags); 1052 channel = idr_find(&glink->rcids, cid); 1053 spin_unlock_irqrestore(&glink->idr_lock, flags); 1054 if (!channel) { 1055 trace_qcom_glink_cmd_intent_rx(glink->label, NULL, 0, cid, count, 0, 0); 1056 dev_err(glink->dev, "intents for non-existing channel\n"); 1057 qcom_glink_rx_advance(glink, ALIGN(msglen, 8)); 1058 return; 1059 } 1060 1061 msg = kmalloc(msglen, GFP_ATOMIC); 1062 if (!msg) 1063 return; 1064 1065 qcom_glink_rx_peek(glink, msg, 0, msglen); 1066 1067 trace_qcom_glink_cmd_intent_rx(glink->label, channel->name, 1068 channel->lcid, cid, count, 1069 count > 0 ? msg->intents[0].size : 0, 1070 count > 0 ? msg->intents[0].iid : 0); 1071 1072 for (i = 0; i < count; ++i) { 1073 intent = kzalloc(sizeof(*intent), GFP_ATOMIC); 1074 if (!intent) 1075 break; 1076 1077 intent->id = le32_to_cpu(msg->intents[i].iid); 1078 intent->size = le32_to_cpu(msg->intents[i].size); 1079 1080 spin_lock_irqsave(&channel->intent_lock, flags); 1081 ret = idr_alloc(&channel->riids, intent, 1082 intent->id, intent->id + 1, GFP_ATOMIC); 1083 spin_unlock_irqrestore(&channel->intent_lock, flags); 1084 1085 if (ret < 0) 1086 dev_err(glink->dev, "failed to store remote intent\n"); 1087 } 1088 1089 WRITE_ONCE(channel->intent_received, true); 1090 wake_up_all(&channel->intent_req_wq); 1091 1092 kfree(msg); 1093 qcom_glink_rx_advance(glink, ALIGN(msglen, 8)); 1094 } 1095 1096 static int qcom_glink_rx_open_ack(struct qcom_glink *glink, unsigned int lcid) 1097 { 1098 struct glink_channel *channel; 1099 1100 qcom_glink_rx_advance(glink, ALIGN(sizeof(struct glink_msg), 8)); 1101 1102 spin_lock(&glink->idr_lock); 1103 channel = idr_find(&glink->lcids, lcid); 1104 spin_unlock(&glink->idr_lock); 1105 1106 trace_qcom_glink_cmd_open_ack_rx(glink->label, channel ? channel->name : NULL, 1107 lcid, channel ? channel->rcid : 0); 1108 if (!channel) { 1109 dev_err(glink->dev, "Invalid open ack packet\n"); 1110 return -EINVAL; 1111 } 1112 1113 complete_all(&channel->open_ack); 1114 1115 return 0; 1116 } 1117 1118 /** 1119 * qcom_glink_set_flow_control() - convert a signal cmd to wire format and transmit 1120 * @ept: Rpmsg endpoint for channel. 1121 * @pause: Pause transmission 1122 * @dst: destination address of the endpoint 1123 * 1124 * Return: 0 on success or standard Linux error code. 1125 */ 1126 static int qcom_glink_set_flow_control(struct rpmsg_endpoint *ept, bool pause, u32 dst) 1127 { 1128 struct glink_channel *channel = to_glink_channel(ept); 1129 struct qcom_glink *glink = channel->glink; 1130 struct glink_msg msg; 1131 u32 sigs = 0; 1132 1133 if (pause) 1134 sigs |= NATIVE_DTR_SIG | NATIVE_RTS_SIG; 1135 1136 msg.cmd = cpu_to_le16(GLINK_CMD_SIGNALS); 1137 msg.param1 = cpu_to_le16(channel->lcid); 1138 msg.param2 = cpu_to_le32(sigs); 1139 1140 trace_qcom_glink_cmd_signal_tx(glink->label, channel->name, 1141 channel->lcid, channel->rcid, sigs); 1142 1143 return qcom_glink_tx(glink, &msg, sizeof(msg), NULL, 0, true); 1144 } 1145 1146 static void qcom_glink_handle_signals(struct qcom_glink *glink, 1147 unsigned int rcid, unsigned int sigs) 1148 { 1149 struct glink_channel *channel; 1150 unsigned long flags; 1151 bool enable; 1152 1153 qcom_glink_rx_advance(glink, ALIGN(sizeof(struct glink_msg), 8)); 1154 1155 spin_lock_irqsave(&glink->idr_lock, flags); 1156 channel = idr_find(&glink->rcids, rcid); 1157 spin_unlock_irqrestore(&glink->idr_lock, flags); 1158 1159 trace_qcom_glink_cmd_signal_rx(glink->label, channel ? channel->name : NULL, 1160 channel ? channel->lcid : 0, rcid, sigs); 1161 if (!channel) { 1162 dev_err(glink->dev, "signal for non-existing channel\n"); 1163 return; 1164 } 1165 1166 enable = sigs & NATIVE_DSR_SIG || sigs & NATIVE_CTS_SIG; 1167 1168 if (channel->ept.flow_cb) 1169 channel->ept.flow_cb(channel->ept.rpdev, channel->ept.priv, enable); 1170 } 1171 1172 void qcom_glink_native_rx(struct qcom_glink *glink) 1173 { 1174 struct glink_msg msg; 1175 unsigned int param1; 1176 unsigned int param2; 1177 unsigned int avail; 1178 unsigned int cmd; 1179 int ret = 0; 1180 1181 /* To wakeup any blocking writers */ 1182 wake_up_all(&glink->tx_avail_notify); 1183 1184 for (;;) { 1185 avail = qcom_glink_rx_avail(glink); 1186 if (avail < sizeof(msg)) 1187 break; 1188 1189 qcom_glink_rx_peek(glink, &msg, 0, sizeof(msg)); 1190 1191 cmd = le16_to_cpu(msg.cmd); 1192 param1 = le16_to_cpu(msg.param1); 1193 param2 = le32_to_cpu(msg.param2); 1194 1195 switch (cmd) { 1196 case GLINK_CMD_VERSION: 1197 case GLINK_CMD_VERSION_ACK: 1198 case GLINK_CMD_CLOSE: 1199 case GLINK_CMD_CLOSE_ACK: 1200 case GLINK_CMD_RX_INTENT_REQ: 1201 ret = qcom_glink_rx_defer(glink, 0); 1202 break; 1203 case GLINK_CMD_OPEN_ACK: 1204 ret = qcom_glink_rx_open_ack(glink, param1); 1205 break; 1206 case GLINK_CMD_OPEN: 1207 ret = qcom_glink_rx_defer(glink, param2); 1208 break; 1209 case GLINK_CMD_TX_DATA: 1210 case GLINK_CMD_TX_DATA_CONT: 1211 ret = qcom_glink_rx_data(glink, avail); 1212 break; 1213 case GLINK_CMD_READ_NOTIF: 1214 qcom_glink_rx_read_notif(glink); 1215 break; 1216 case GLINK_CMD_INTENT: 1217 qcom_glink_handle_intent(glink, param1, param2, avail); 1218 break; 1219 case GLINK_CMD_RX_DONE: 1220 qcom_glink_handle_rx_done(glink, param1, param2, false); 1221 break; 1222 case GLINK_CMD_RX_DONE_W_REUSE: 1223 qcom_glink_handle_rx_done(glink, param1, param2, true); 1224 break; 1225 case GLINK_CMD_RX_INTENT_REQ_ACK: 1226 qcom_glink_handle_intent_req_ack(glink, param1, param2); 1227 break; 1228 case GLINK_CMD_SIGNALS: 1229 qcom_glink_handle_signals(glink, param1, param2); 1230 break; 1231 default: 1232 dev_err(glink->dev, "unhandled rx cmd: %d\n", cmd); 1233 ret = -EINVAL; 1234 break; 1235 } 1236 1237 if (ret) 1238 break; 1239 } 1240 } 1241 EXPORT_SYMBOL(qcom_glink_native_rx); 1242 1243 /* Locally initiated rpmsg_create_ept */ 1244 static struct glink_channel *qcom_glink_create_local(struct qcom_glink *glink, 1245 const char *name) 1246 { 1247 struct glink_channel *channel; 1248 int ret; 1249 unsigned long flags; 1250 1251 channel = qcom_glink_alloc_channel(glink, name); 1252 if (IS_ERR(channel)) 1253 return ERR_CAST(channel); 1254 1255 ret = qcom_glink_send_open_req(glink, channel); 1256 if (ret) 1257 goto release_channel; 1258 1259 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ); 1260 if (!ret) 1261 goto err_timeout; 1262 1263 ret = wait_for_completion_timeout(&channel->open_req, 5 * HZ); 1264 if (!ret) 1265 goto err_timeout; 1266 1267 qcom_glink_send_open_ack(glink, channel); 1268 1269 return channel; 1270 1271 err_timeout: 1272 /* qcom_glink_send_open_req() did register the channel in lcids*/ 1273 spin_lock_irqsave(&glink->idr_lock, flags); 1274 idr_remove(&glink->lcids, channel->lcid); 1275 spin_unlock_irqrestore(&glink->idr_lock, flags); 1276 1277 release_channel: 1278 /* Release qcom_glink_send_open_req() reference */ 1279 kref_put(&channel->refcount, qcom_glink_channel_release); 1280 /* Release qcom_glink_alloc_channel() reference */ 1281 kref_put(&channel->refcount, qcom_glink_channel_release); 1282 1283 return ERR_PTR(-ETIMEDOUT); 1284 } 1285 1286 /* Remote initiated rpmsg_create_ept */ 1287 static int qcom_glink_create_remote(struct qcom_glink *glink, 1288 struct glink_channel *channel) 1289 { 1290 int ret; 1291 1292 qcom_glink_send_open_ack(glink, channel); 1293 1294 ret = qcom_glink_send_open_req(glink, channel); 1295 if (ret) 1296 goto close_link; 1297 1298 ret = wait_for_completion_timeout(&channel->open_ack, 5 * HZ); 1299 if (!ret) { 1300 ret = -ETIMEDOUT; 1301 goto close_link; 1302 } 1303 1304 return 0; 1305 1306 close_link: 1307 /* 1308 * Send a close request to "undo" our open-ack. The close-ack will 1309 * release qcom_glink_send_open_req() reference and the last reference 1310 * will be relesed after receiving remote_close or transport unregister 1311 * by calling qcom_glink_native_remove(). 1312 */ 1313 qcom_glink_send_close_req(glink, channel); 1314 1315 return ret; 1316 } 1317 1318 static struct rpmsg_endpoint *qcom_glink_create_ept(struct rpmsg_device *rpdev, 1319 rpmsg_rx_cb_t cb, 1320 void *priv, 1321 struct rpmsg_channel_info 1322 chinfo) 1323 { 1324 struct glink_channel *parent = to_glink_channel(rpdev->ept); 1325 struct glink_channel *channel; 1326 struct qcom_glink *glink = parent->glink; 1327 struct rpmsg_endpoint *ept; 1328 const char *name = chinfo.name; 1329 int cid; 1330 int ret; 1331 unsigned long flags; 1332 1333 spin_lock_irqsave(&glink->idr_lock, flags); 1334 idr_for_each_entry(&glink->rcids, channel, cid) { 1335 if (!strcmp(channel->name, name)) 1336 break; 1337 } 1338 spin_unlock_irqrestore(&glink->idr_lock, flags); 1339 1340 if (!channel) { 1341 channel = qcom_glink_create_local(glink, name); 1342 if (IS_ERR(channel)) 1343 return NULL; 1344 } else { 1345 ret = qcom_glink_create_remote(glink, channel); 1346 if (ret) 1347 return NULL; 1348 } 1349 1350 ept = &channel->ept; 1351 ept->rpdev = rpdev; 1352 ept->cb = cb; 1353 ept->priv = priv; 1354 ept->ops = &glink_endpoint_ops; 1355 1356 return ept; 1357 } 1358 1359 static int qcom_glink_announce_create(struct rpmsg_device *rpdev) 1360 { 1361 struct glink_channel *channel = to_glink_channel(rpdev->ept); 1362 struct device_node *np = rpdev->dev.of_node; 1363 struct qcom_glink *glink = channel->glink; 1364 struct glink_core_rx_intent *intent; 1365 const struct property *prop = NULL; 1366 __be32 defaults[] = { cpu_to_be32(SZ_1K), cpu_to_be32(5) }; 1367 int num_intents; 1368 int num_groups = 1; 1369 __be32 *val = defaults; 1370 int size; 1371 1372 if (glink->intentless || !completion_done(&channel->open_ack)) 1373 return 0; 1374 1375 prop = of_find_property(np, "qcom,intents", NULL); 1376 if (prop) { 1377 val = prop->value; 1378 num_groups = prop->length / sizeof(u32) / 2; 1379 } 1380 1381 /* Channel is now open, advertise base set of intents */ 1382 while (num_groups--) { 1383 size = be32_to_cpup(val++); 1384 num_intents = be32_to_cpup(val++); 1385 while (num_intents--) { 1386 intent = qcom_glink_alloc_intent(glink, channel, size, 1387 true); 1388 if (!intent) 1389 break; 1390 1391 qcom_glink_advertise_intent(glink, channel, intent); 1392 } 1393 } 1394 return 0; 1395 } 1396 1397 static void qcom_glink_destroy_ept(struct rpmsg_endpoint *ept) 1398 { 1399 struct glink_channel *channel = to_glink_channel(ept); 1400 struct qcom_glink *glink = channel->glink; 1401 unsigned long flags; 1402 1403 spin_lock_irqsave(&channel->recv_lock, flags); 1404 channel->ept.cb = NULL; 1405 spin_unlock_irqrestore(&channel->recv_lock, flags); 1406 1407 /* Decouple the potential rpdev from the channel */ 1408 channel->rpdev = NULL; 1409 1410 qcom_glink_send_close_req(glink, channel); 1411 } 1412 1413 static int qcom_glink_request_intent(struct qcom_glink *glink, 1414 struct glink_channel *channel, 1415 size_t size) 1416 { 1417 struct { 1418 u16 id; 1419 u16 cid; 1420 u32 size; 1421 } __packed cmd; 1422 1423 int ret; 1424 1425 mutex_lock(&channel->intent_req_lock); 1426 1427 WRITE_ONCE(channel->intent_req_result, -1); 1428 WRITE_ONCE(channel->intent_received, false); 1429 1430 cmd.id = GLINK_CMD_RX_INTENT_REQ; 1431 cmd.cid = channel->lcid; 1432 cmd.size = size; 1433 1434 trace_qcom_glink_cmd_rx_intent_req_tx(glink->label, channel->name, 1435 channel->lcid, channel->rcid, 1436 cmd.size); 1437 1438 ret = qcom_glink_tx(glink, &cmd, sizeof(cmd), NULL, 0, true); 1439 if (ret) 1440 goto unlock; 1441 1442 ret = wait_event_timeout(channel->intent_req_wq, 1443 READ_ONCE(channel->intent_req_result) >= 0 && 1444 READ_ONCE(channel->intent_received), 1445 10 * HZ); 1446 if (!ret) { 1447 dev_err(glink->dev, "intent request timed out\n"); 1448 ret = -ETIMEDOUT; 1449 } else { 1450 ret = READ_ONCE(channel->intent_req_result) ? 0 : -ECANCELED; 1451 } 1452 1453 unlock: 1454 mutex_unlock(&channel->intent_req_lock); 1455 return ret; 1456 } 1457 1458 static int __qcom_glink_send(struct glink_channel *channel, 1459 void *data, int len, bool wait) 1460 { 1461 struct qcom_glink *glink = channel->glink; 1462 struct glink_core_rx_intent *intent = NULL; 1463 struct glink_core_rx_intent *tmp; 1464 int iid = 0; 1465 struct { 1466 struct glink_msg_hdr msg; 1467 __le32 chunk_size; 1468 __le32 left_size; 1469 } __packed req; 1470 int ret; 1471 unsigned long flags; 1472 int chunk_size = len; 1473 size_t offset = 0; 1474 1475 if (!glink->intentless) { 1476 while (!intent) { 1477 spin_lock_irqsave(&channel->intent_lock, flags); 1478 idr_for_each_entry(&channel->riids, tmp, iid) { 1479 if (tmp->size >= len && !tmp->in_use) { 1480 if (!intent) 1481 intent = tmp; 1482 else if (intent->size > tmp->size) 1483 intent = tmp; 1484 if (intent->size == len) 1485 break; 1486 } 1487 } 1488 if (intent) 1489 intent->in_use = true; 1490 spin_unlock_irqrestore(&channel->intent_lock, flags); 1491 1492 /* We found an available intent */ 1493 if (intent) 1494 break; 1495 1496 if (!wait) 1497 return -EBUSY; 1498 1499 ret = qcom_glink_request_intent(glink, channel, len); 1500 if (ret < 0) 1501 return ret; 1502 } 1503 1504 iid = intent->id; 1505 } 1506 1507 while (offset < len) { 1508 chunk_size = len - offset; 1509 if (chunk_size > SZ_8K && wait) 1510 chunk_size = SZ_8K; 1511 1512 req.msg.cmd = cpu_to_le16(offset == 0 ? GLINK_CMD_TX_DATA : GLINK_CMD_TX_DATA_CONT); 1513 req.msg.param1 = cpu_to_le16(channel->lcid); 1514 req.msg.param2 = cpu_to_le32(iid); 1515 req.chunk_size = cpu_to_le32(chunk_size); 1516 req.left_size = cpu_to_le32(len - offset - chunk_size); 1517 1518 trace_qcom_glink_cmd_tx_data_tx(glink->label, channel->name, 1519 channel->lcid, channel->rcid, 1520 iid, chunk_size, 1521 len - offset - chunk_size, 1522 offset > 0); 1523 1524 ret = qcom_glink_tx(glink, &req, sizeof(req), data + offset, chunk_size, wait); 1525 if (ret) { 1526 /* Mark intent available if we failed */ 1527 if (intent) 1528 intent->in_use = false; 1529 return ret; 1530 } 1531 1532 offset += chunk_size; 1533 } 1534 1535 return 0; 1536 } 1537 1538 static int qcom_glink_send(struct rpmsg_endpoint *ept, void *data, int len) 1539 { 1540 struct glink_channel *channel = to_glink_channel(ept); 1541 1542 return __qcom_glink_send(channel, data, len, true); 1543 } 1544 1545 static int qcom_glink_trysend(struct rpmsg_endpoint *ept, void *data, int len) 1546 { 1547 struct glink_channel *channel = to_glink_channel(ept); 1548 1549 return __qcom_glink_send(channel, data, len, false); 1550 } 1551 1552 static int qcom_glink_sendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst) 1553 { 1554 struct glink_channel *channel = to_glink_channel(ept); 1555 1556 return __qcom_glink_send(channel, data, len, true); 1557 } 1558 1559 static int qcom_glink_trysendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst) 1560 { 1561 struct glink_channel *channel = to_glink_channel(ept); 1562 1563 return __qcom_glink_send(channel, data, len, false); 1564 } 1565 1566 /* 1567 * Finds the device_node for the glink child interested in this channel. 1568 */ 1569 static struct device_node *qcom_glink_match_channel(struct device_node *node, 1570 const char *channel) 1571 { 1572 struct device_node *child; 1573 const char *name; 1574 const char *key; 1575 int ret; 1576 1577 for_each_available_child_of_node(node, child) { 1578 key = "qcom,glink-channels"; 1579 ret = of_property_read_string(child, key, &name); 1580 if (ret) 1581 continue; 1582 1583 if (strcmp(name, channel) == 0) 1584 return child; 1585 } 1586 1587 return NULL; 1588 } 1589 1590 static const struct rpmsg_device_ops glink_device_ops = { 1591 .create_ept = qcom_glink_create_ept, 1592 .announce_create = qcom_glink_announce_create, 1593 }; 1594 1595 static const struct rpmsg_endpoint_ops glink_endpoint_ops = { 1596 .destroy_ept = qcom_glink_destroy_ept, 1597 .send = qcom_glink_send, 1598 .sendto = qcom_glink_sendto, 1599 .trysend = qcom_glink_trysend, 1600 .trysendto = qcom_glink_trysendto, 1601 .set_flow_control = qcom_glink_set_flow_control, 1602 }; 1603 1604 static void qcom_glink_rpdev_release(struct device *dev) 1605 { 1606 struct rpmsg_device *rpdev = to_rpmsg_device(dev); 1607 1608 kfree(rpdev->driver_override); 1609 kfree(rpdev); 1610 } 1611 1612 static int qcom_glink_rx_open(struct qcom_glink *glink, unsigned int rcid, 1613 char *name) 1614 { 1615 struct glink_channel *channel; 1616 struct rpmsg_device *rpdev; 1617 bool create_device = false; 1618 struct device_node *node; 1619 int lcid; 1620 int ret; 1621 unsigned long flags; 1622 1623 spin_lock_irqsave(&glink->idr_lock, flags); 1624 idr_for_each_entry(&glink->lcids, channel, lcid) { 1625 if (!strcmp(channel->name, name)) 1626 break; 1627 } 1628 spin_unlock_irqrestore(&glink->idr_lock, flags); 1629 1630 if (!channel) { 1631 channel = qcom_glink_alloc_channel(glink, name); 1632 if (IS_ERR(channel)) 1633 return PTR_ERR(channel); 1634 1635 /* The opening dance was initiated by the remote */ 1636 create_device = true; 1637 } 1638 1639 trace_qcom_glink_cmd_open_rx(glink->label, name, channel->lcid, rcid); 1640 1641 spin_lock_irqsave(&glink->idr_lock, flags); 1642 ret = idr_alloc(&glink->rcids, channel, rcid, rcid + 1, GFP_ATOMIC); 1643 if (ret < 0) { 1644 dev_err(glink->dev, "Unable to insert channel into rcid list\n"); 1645 spin_unlock_irqrestore(&glink->idr_lock, flags); 1646 goto free_channel; 1647 } 1648 channel->rcid = ret; 1649 spin_unlock_irqrestore(&glink->idr_lock, flags); 1650 1651 complete_all(&channel->open_req); 1652 1653 if (create_device) { 1654 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL); 1655 if (!rpdev) { 1656 ret = -ENOMEM; 1657 goto rcid_remove; 1658 } 1659 1660 rpdev->ept = &channel->ept; 1661 strscpy_pad(rpdev->id.name, name, RPMSG_NAME_SIZE); 1662 rpdev->src = RPMSG_ADDR_ANY; 1663 rpdev->dst = RPMSG_ADDR_ANY; 1664 rpdev->ops = &glink_device_ops; 1665 1666 node = qcom_glink_match_channel(glink->dev->of_node, name); 1667 rpdev->dev.of_node = node; 1668 rpdev->dev.parent = glink->dev; 1669 rpdev->dev.release = qcom_glink_rpdev_release; 1670 1671 ret = rpmsg_register_device(rpdev); 1672 if (ret) 1673 goto rcid_remove; 1674 1675 channel->rpdev = rpdev; 1676 } 1677 1678 return 0; 1679 1680 rcid_remove: 1681 spin_lock_irqsave(&glink->idr_lock, flags); 1682 idr_remove(&glink->rcids, channel->rcid); 1683 channel->rcid = 0; 1684 spin_unlock_irqrestore(&glink->idr_lock, flags); 1685 free_channel: 1686 /* Release the reference, iff we took it */ 1687 if (create_device) 1688 kref_put(&channel->refcount, qcom_glink_channel_release); 1689 1690 return ret; 1691 } 1692 1693 static void qcom_glink_rx_close(struct qcom_glink *glink, unsigned int rcid) 1694 { 1695 struct rpmsg_channel_info chinfo; 1696 struct glink_channel *channel; 1697 unsigned long flags; 1698 1699 spin_lock_irqsave(&glink->idr_lock, flags); 1700 channel = idr_find(&glink->rcids, rcid); 1701 spin_unlock_irqrestore(&glink->idr_lock, flags); 1702 1703 trace_qcom_glink_cmd_close_rx(glink->label, channel ? channel->name : NULL, 1704 channel ? channel->lcid : 0, rcid); 1705 if (WARN(!channel, "close request on unknown channel\n")) 1706 return; 1707 1708 /* cancel pending rx_done work */ 1709 cancel_work_sync(&channel->intent_work); 1710 1711 if (channel->rpdev) { 1712 strscpy_pad(chinfo.name, channel->name, sizeof(chinfo.name)); 1713 chinfo.src = RPMSG_ADDR_ANY; 1714 chinfo.dst = RPMSG_ADDR_ANY; 1715 1716 rpmsg_unregister_device(glink->dev, &chinfo); 1717 } 1718 channel->rpdev = NULL; 1719 1720 qcom_glink_send_close_ack(glink, channel); 1721 1722 spin_lock_irqsave(&glink->idr_lock, flags); 1723 idr_remove(&glink->rcids, channel->rcid); 1724 channel->rcid = 0; 1725 spin_unlock_irqrestore(&glink->idr_lock, flags); 1726 1727 kref_put(&channel->refcount, qcom_glink_channel_release); 1728 } 1729 1730 static void qcom_glink_rx_close_ack(struct qcom_glink *glink, unsigned int lcid) 1731 { 1732 struct rpmsg_channel_info chinfo; 1733 struct glink_channel *channel; 1734 unsigned long flags; 1735 1736 /* To wakeup any blocking writers */ 1737 wake_up_all(&glink->tx_avail_notify); 1738 1739 spin_lock_irqsave(&glink->idr_lock, flags); 1740 channel = idr_find(&glink->lcids, lcid); 1741 1742 trace_qcom_glink_cmd_close_ack_rx(glink->label, channel ? channel->name : NULL, 1743 lcid, channel ? channel->rcid : 0); 1744 if (WARN(!channel, "close ack on unknown channel\n")) { 1745 spin_unlock_irqrestore(&glink->idr_lock, flags); 1746 return; 1747 } 1748 1749 idr_remove(&glink->lcids, channel->lcid); 1750 channel->lcid = 0; 1751 spin_unlock_irqrestore(&glink->idr_lock, flags); 1752 1753 /* Decouple the potential rpdev from the channel */ 1754 if (channel->rpdev) { 1755 strscpy(chinfo.name, channel->name, sizeof(chinfo.name)); 1756 chinfo.src = RPMSG_ADDR_ANY; 1757 chinfo.dst = RPMSG_ADDR_ANY; 1758 1759 rpmsg_unregister_device(glink->dev, &chinfo); 1760 } 1761 channel->rpdev = NULL; 1762 1763 kref_put(&channel->refcount, qcom_glink_channel_release); 1764 } 1765 1766 static void qcom_glink_work(struct work_struct *work) 1767 { 1768 struct qcom_glink *glink = container_of(work, struct qcom_glink, 1769 rx_work); 1770 struct glink_defer_cmd *dcmd; 1771 struct glink_msg *msg; 1772 unsigned long flags; 1773 unsigned int param1; 1774 unsigned int param2; 1775 unsigned int cmd; 1776 1777 for (;;) { 1778 spin_lock_irqsave(&glink->rx_lock, flags); 1779 if (list_empty(&glink->rx_queue)) { 1780 spin_unlock_irqrestore(&glink->rx_lock, flags); 1781 break; 1782 } 1783 dcmd = list_first_entry(&glink->rx_queue, 1784 struct glink_defer_cmd, node); 1785 list_del(&dcmd->node); 1786 spin_unlock_irqrestore(&glink->rx_lock, flags); 1787 1788 msg = container_of(&dcmd->msg, struct glink_msg, hdr); 1789 cmd = le16_to_cpu(msg->cmd); 1790 param1 = le16_to_cpu(msg->param1); 1791 param2 = le32_to_cpu(msg->param2); 1792 1793 switch (cmd) { 1794 case GLINK_CMD_VERSION: 1795 qcom_glink_receive_version(glink, param1, param2); 1796 break; 1797 case GLINK_CMD_VERSION_ACK: 1798 qcom_glink_receive_version_ack(glink, param1, param2); 1799 break; 1800 case GLINK_CMD_OPEN: 1801 qcom_glink_rx_open(glink, param1, msg->data); 1802 break; 1803 case GLINK_CMD_CLOSE: 1804 qcom_glink_rx_close(glink, param1); 1805 break; 1806 case GLINK_CMD_CLOSE_ACK: 1807 qcom_glink_rx_close_ack(glink, param1); 1808 break; 1809 case GLINK_CMD_RX_INTENT_REQ: 1810 qcom_glink_handle_intent_req(glink, param1, param2); 1811 break; 1812 default: 1813 WARN(1, "Unknown defer object %d\n", cmd); 1814 break; 1815 } 1816 1817 kfree(dcmd); 1818 } 1819 } 1820 1821 static void qcom_glink_cancel_rx_work(struct qcom_glink *glink) 1822 { 1823 struct glink_defer_cmd *dcmd; 1824 struct glink_defer_cmd *tmp; 1825 1826 /* cancel any pending deferred rx_work */ 1827 cancel_work_sync(&glink->rx_work); 1828 1829 list_for_each_entry_safe(dcmd, tmp, &glink->rx_queue, node) 1830 kfree(dcmd); 1831 } 1832 1833 static ssize_t rpmsg_name_show(struct device *dev, 1834 struct device_attribute *attr, char *buf) 1835 { 1836 int ret = 0; 1837 const char *name; 1838 1839 ret = of_property_read_string(dev->of_node, "label", &name); 1840 if (ret < 0) 1841 name = dev->of_node->name; 1842 1843 return sysfs_emit(buf, "%s\n", name); 1844 } 1845 static DEVICE_ATTR_RO(rpmsg_name); 1846 1847 static struct attribute *qcom_glink_attrs[] = { 1848 &dev_attr_rpmsg_name.attr, 1849 NULL 1850 }; 1851 ATTRIBUTE_GROUPS(qcom_glink); 1852 1853 static void qcom_glink_device_release(struct device *dev) 1854 { 1855 struct rpmsg_device *rpdev = to_rpmsg_device(dev); 1856 struct glink_channel *channel = to_glink_channel(rpdev->ept); 1857 1858 /* Release qcom_glink_alloc_channel() reference */ 1859 kref_put(&channel->refcount, qcom_glink_channel_release); 1860 kfree(rpdev->driver_override); 1861 kfree(rpdev); 1862 } 1863 1864 static int qcom_glink_create_chrdev(struct qcom_glink *glink) 1865 { 1866 struct rpmsg_device *rpdev; 1867 struct glink_channel *channel; 1868 1869 rpdev = kzalloc(sizeof(*rpdev), GFP_KERNEL); 1870 if (!rpdev) 1871 return -ENOMEM; 1872 1873 channel = qcom_glink_alloc_channel(glink, "rpmsg_chrdev"); 1874 if (IS_ERR(channel)) { 1875 kfree(rpdev); 1876 return PTR_ERR(channel); 1877 } 1878 channel->rpdev = rpdev; 1879 1880 rpdev->ept = &channel->ept; 1881 rpdev->ops = &glink_device_ops; 1882 rpdev->dev.parent = glink->dev; 1883 rpdev->dev.release = qcom_glink_device_release; 1884 1885 return rpmsg_ctrldev_register_device(rpdev); 1886 } 1887 1888 struct qcom_glink *qcom_glink_native_probe(struct device *dev, 1889 unsigned long features, 1890 struct qcom_glink_pipe *rx, 1891 struct qcom_glink_pipe *tx, 1892 bool intentless) 1893 { 1894 int ret; 1895 struct qcom_glink *glink; 1896 1897 glink = devm_kzalloc(dev, sizeof(*glink), GFP_KERNEL); 1898 if (!glink) 1899 return ERR_PTR(-ENOMEM); 1900 1901 glink->dev = dev; 1902 glink->tx_pipe = tx; 1903 glink->rx_pipe = rx; 1904 1905 glink->features = features; 1906 glink->intentless = intentless; 1907 1908 spin_lock_init(&glink->tx_lock); 1909 spin_lock_init(&glink->rx_lock); 1910 INIT_LIST_HEAD(&glink->rx_queue); 1911 INIT_WORK(&glink->rx_work, qcom_glink_work); 1912 init_waitqueue_head(&glink->tx_avail_notify); 1913 1914 spin_lock_init(&glink->idr_lock); 1915 idr_init(&glink->lcids); 1916 idr_init(&glink->rcids); 1917 1918 ret = of_property_read_string(dev->of_node, "label", &glink->label); 1919 if (ret < 0) 1920 glink->label = dev->of_node->name; 1921 1922 glink->dev->groups = qcom_glink_groups; 1923 1924 ret = device_add_groups(dev, qcom_glink_groups); 1925 if (ret) 1926 dev_err(dev, "failed to add groups\n"); 1927 1928 ret = qcom_glink_send_version(glink); 1929 if (ret) 1930 return ERR_PTR(ret); 1931 1932 ret = qcom_glink_create_chrdev(glink); 1933 if (ret) 1934 dev_err(glink->dev, "failed to register chrdev\n"); 1935 1936 return glink; 1937 } 1938 EXPORT_SYMBOL_GPL(qcom_glink_native_probe); 1939 1940 static int qcom_glink_remove_device(struct device *dev, void *data) 1941 { 1942 device_unregister(dev); 1943 1944 return 0; 1945 } 1946 1947 void qcom_glink_native_remove(struct qcom_glink *glink) 1948 { 1949 struct glink_channel *channel; 1950 unsigned long flags; 1951 int cid; 1952 int ret; 1953 1954 qcom_glink_cancel_rx_work(glink); 1955 1956 /* Fail all attempts at sending messages */ 1957 spin_lock_irqsave(&glink->tx_lock, flags); 1958 glink->abort_tx = true; 1959 wake_up_all(&glink->tx_avail_notify); 1960 spin_unlock_irqrestore(&glink->tx_lock, flags); 1961 1962 /* Abort any senders waiting for intent requests */ 1963 spin_lock_irqsave(&glink->idr_lock, flags); 1964 idr_for_each_entry(&glink->lcids, channel, cid) 1965 qcom_glink_intent_req_abort(channel); 1966 spin_unlock_irqrestore(&glink->idr_lock, flags); 1967 1968 ret = device_for_each_child(glink->dev, NULL, qcom_glink_remove_device); 1969 if (ret) 1970 dev_warn(glink->dev, "Can't remove GLINK devices: %d\n", ret); 1971 1972 /* Release any defunct local channels, waiting for close-ack */ 1973 idr_for_each_entry(&glink->lcids, channel, cid) 1974 kref_put(&channel->refcount, qcom_glink_channel_release); 1975 1976 /* Release any defunct local channels, waiting for close-req */ 1977 idr_for_each_entry(&glink->rcids, channel, cid) 1978 kref_put(&channel->refcount, qcom_glink_channel_release); 1979 1980 idr_destroy(&glink->lcids); 1981 idr_destroy(&glink->rcids); 1982 } 1983 EXPORT_SYMBOL_GPL(qcom_glink_native_remove); 1984 1985 MODULE_DESCRIPTION("Qualcomm GLINK driver"); 1986 MODULE_LICENSE("GPL v2"); 1987