drivers/mailbox/mailbox.c

   1 /*
   2  * Mailbox: Common code for Mailbox controllers and users
   3  *
   4  * Copyright (C) 2013-2014 Linaro Ltd.
   5  * Author: Jassi Brar <jassisinghbrar@gmail.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #include <linux/interrupt.h>
  13 #include <linux/spinlock.h>
  14 #include <linux/mutex.h>
  15 #include <linux/delay.h>
  16 #include <linux/slab.h>
  17 #include <linux/err.h>
  18 #include <linux/module.h>
  19 #include <linux/device.h>
  20 #include <linux/bitops.h>
  21 #include <linux/mailbox_client.h>
  22 #include <linux/mailbox_controller.h>
  23
  24 #include "mailbox.h"
  25
  26 static LIST_HEAD(mbox_cons);
  27 static DEFINE_MUTEX(con_mutex);
  28
  29 static int add_to_rbuf(struct mbox_chan *chan, void *mssg)
  30 {
  31         int idx;
  32         unsigned long flags;
  33
  34         spin_lock_irqsave(&chan->lock, flags);
  35
  36         /* See if there is any space left */
  37         if (chan->msg_count == MBOX_TX_QUEUE_LEN) {
  38                 spin_unlock_irqrestore(&chan->lock, flags);
  39                 return -ENOBUFS;
  40         }
  41
  42         idx = chan->msg_free;
  43         chan->msg_data[idx] = mssg;
  44         chan->msg_count++;
  45
  46         if (idx == MBOX_TX_QUEUE_LEN - 1)
  47                 chan->msg_free = 0;
  48         else
  49                 chan->msg_free++;
  50
  51         spin_unlock_irqrestore(&chan->lock, flags);
  52
  53         return idx;
  54 }
  55
  56 static void msg_submit(struct mbox_chan *chan)
  57 {
  58         unsigned count, idx;
  59         unsigned long flags;
  60         void *data;
  61         int err = -EBUSY;
  62
  63         spin_lock_irqsave(&chan->lock, flags);
  64
  65         if (!chan->msg_count || chan->active_req)
  66                 goto exit;
  67
  68         count = chan->msg_count;
  69         idx = chan->msg_free;
  70         if (idx >= count)
  71                 idx -= count;
  72         else
  73                 idx += MBOX_TX_QUEUE_LEN - count;
  74
  75         data = chan->msg_data[idx];
  76
  77         if (chan->cl->tx_prepare)
  78                 chan->cl->tx_prepare(chan->cl, data);
  79         /* Try to submit a message to the MBOX controller */
  80         err = chan->mbox->ops->send_data(chan, data);
  81         if (!err) {
  82                 chan->active_req = data;
  83                 chan->msg_count--;
  84         }
  85 exit:
  86         spin_unlock_irqrestore(&chan->lock, flags);
  87
  88         if (!err && (chan->txdone_method & TXDONE_BY_POLL))
  89                 /* kick start the timer immediately to avoid delays */
  90                 hrtimer_start(&chan->mbox->poll_hrt, ktime_set(0, 0),
  91                               HRTIMER_MODE_REL);
  92 }
  93
  94 static void tx_tick(struct mbox_chan *chan, int r)
  95 {
  96         unsigned long flags;
  97         void *mssg;
  98
  99         spin_lock_irqsave(&chan->lock, flags);
 100         mssg = chan->active_req;
 101         chan->active_req = NULL;
 102         spin_unlock_irqrestore(&chan->lock, flags);
 103
 104         /* Submit next message */
 105         msg_submit(chan);
 106
 107         if (!mssg)
 108                 return;
 109
 110         /* Notify the client */
 111         if (chan->cl->tx_done)
 112                 chan->cl->tx_done(chan->cl, mssg, r);
 113
 114         if (r != -ETIME && chan->cl->tx_block)
 115                 complete(&chan->tx_complete);
 116 }
 117
 118 static enum hrtimer_restart txdone_hrtimer(struct hrtimer *hrtimer)
 119 {
 120         struct mbox_controller *mbox =
 121                 container_of(hrtimer, struct mbox_controller, poll_hrt);
 122         bool txdone, resched = false;
 123         int i;
 124
 125         for (i = 0; i < mbox->num_chans; i++) {
 126                 struct mbox_chan *chan = &mbox->chans[i];
 127
 128                 if (chan->active_req && chan->cl) {
 129                         txdone = chan->mbox->ops->last_tx_done(chan);
 130                         if (txdone)
 131                                 tx_tick(chan, 0);
 132                         else
 133                                 resched = true;
 134                 }
 135         }
 136
 137         if (resched) {
 138                 hrtimer_forward_now(hrtimer, ms_to_ktime(mbox->txpoll_period));
 139                 return HRTIMER_RESTART;
 140         }
 141         return HRTIMER_NORESTART;
 142 }
 143
 144 /**
 145  * mbox_chan_received_data - A way for controller driver to push data
 146  *                              received from remote to the upper layer.
 147  * @chan: Pointer to the mailbox channel on which RX happened.
 148  * @mssg: Client specific message typecasted as void *
 149  *
 150  * After startup and before shutdown any data received on the chan
 151  * is passed on to the API via atomic mbox_chan_received_data().
 152  * The controller should ACK the RX only after this call returns.
 153  */
 154 void mbox_chan_received_data(struct mbox_chan *chan, void *mssg)
 155 {
 156         /* No buffering the received data */
 157         if (chan->cl->rx_callback)
 158                 chan->cl->rx_callback(chan->cl, mssg);
 159 }
 160 EXPORT_SYMBOL_GPL(mbox_chan_received_data);
 161
 162 /**
 163  * mbox_chan_txdone - A way for controller driver to notify the
 164  *                      framework that the last TX has completed.
 165  * @chan: Pointer to the mailbox chan on which TX happened.
 166  * @r: Status of last TX - OK or ERROR
 167  *
 168  * The controller that has IRQ for TX ACK calls this atomic API
 169  * to tick the TX state machine. It works only if txdone_irq
 170  * is set by the controller.
 171  */
 172 void mbox_chan_txdone(struct mbox_chan *chan, int r)
 173 {
 174         if (unlikely(!(chan->txdone_method & TXDONE_BY_IRQ))) {
 175                 dev_err(chan->mbox->dev,
 176                        "Controller can't run the TX ticker\n");
 177                 return;
 178         }
 179
 180         tx_tick(chan, r);
 181 }
 182 EXPORT_SYMBOL_GPL(mbox_chan_txdone);
 183
 184 /**
 185  * mbox_client_txdone - The way for a client to run the TX state machine.
 186  * @chan: Mailbox channel assigned to this client.
 187  * @r: Success status of last transmission.
 188  *
 189  * The client/protocol had received some 'ACK' packet and it notifies
 190  * the API that the last packet was sent successfully. This only works
 191  * if the controller can't sense TX-Done.
 192  */
 193 void mbox_client_txdone(struct mbox_chan *chan, int r)
 194 {
 195         if (unlikely(!(chan->txdone_method & TXDONE_BY_ACK))) {
 196                 dev_err(chan->mbox->dev, "Client can't run the TX ticker\n");
 197                 return;
 198         }
 199
 200         tx_tick(chan, r);
 201 }
 202 EXPORT_SYMBOL_GPL(mbox_client_txdone);
 203
 204 /**
 205  * mbox_client_peek_data - A way for client driver to pull data
 206  *                      received from remote by the controller.
 207  * @chan: Mailbox channel assigned to this client.
 208  *
 209  * A poke to controller driver for any received data.
 210  * The data is actually passed onto client via the
 211  * mbox_chan_received_data()
 212  * The call can be made from atomic context, so the controller's
 213  * implementation of peek_data() must not sleep.
 214  *
 215  * Return: True, if controller has, and is going to push after this,
 216  *          some data.
 217  *         False, if controller doesn't have any data to be read.
 218  */
 219 bool mbox_client_peek_data(struct mbox_chan *chan)
 220 {
 221         if (chan->mbox->ops->peek_data)
 222                 return chan->mbox->ops->peek_data(chan);
 223
 224         return false;
 225 }
 226 EXPORT_SYMBOL_GPL(mbox_client_peek_data);
 227
 228 /**
 229  * mbox_send_message -  For client to submit a message to be
 230  *                              sent to the remote.
 231  * @chan: Mailbox channel assigned to this client.
 232  * @mssg: Client specific message typecasted.
 233  *
 234  * For client to submit data to the controller destined for a remote
 235  * processor. If the client had set 'tx_block', the call will return
 236  * either when the remote receives the data or when 'tx_tout' millisecs
 237  * run out.
 238  *  In non-blocking mode, the requests are buffered by the API and a
 239  * non-negative token is returned for each queued request. If the request
 240  * is not queued, a negative token is returned. Upon failure or successful
 241  * TX, the API calls 'tx_done' from atomic context, from which the client
 242  * could submit yet another request.
 243  * The pointer to message should be preserved until it is sent
 244  * over the chan, i.e, tx_done() is made.
 245  * This function could be called from atomic context as it simply
 246  * queues the data and returns a token against the request.
 247  *
 248  * Return: Non-negative integer for successful submission (non-blocking mode)
 249  *      or transmission over chan (blocking mode).
 250  *      Negative value denotes failure.
 251  */
 252 int mbox_send_message(struct mbox_chan *chan, void *mssg)
 253 {
 254         int t;
 255
 256         if (!chan || !chan->cl)
 257                 return -EINVAL;
 258
 259         t = add_to_rbuf(chan, mssg);
 260         if (t < 0) {
 261                 dev_err(chan->mbox->dev, "Try increasing MBOX_TX_QUEUE_LEN\n");
 262                 return t;
 263         }
 264
 265         msg_submit(chan);
 266
 267         if (chan->cl->tx_block) {
 268                 unsigned long wait;
 269                 int ret;
 270
 271                 if (!chan->cl->tx_tout) /* wait forever */
 272                         wait = msecs_to_jiffies(3600000);
 273                 else
 274                         wait = msecs_to_jiffies(chan->cl->tx_tout);
 275
 276                 ret = wait_for_completion_timeout(&chan->tx_complete, wait);
 277                 if (ret == 0) {
 278                         t = -ETIME;
 279                         tx_tick(chan, t);
 280                 }
 281         }
 282
 283         return t;
 284 }
 285 EXPORT_SYMBOL_GPL(mbox_send_message);
 286
 287 /**
 288  * mbox_request_channel - Request a mailbox channel.
 289  * @cl: Identity of the client requesting the channel.
 290  * @index: Index of mailbox specifier in 'mboxes' property.
 291  *
 292  * The Client specifies its requirements and capabilities while asking for
 293  * a mailbox channel. It can't be called from atomic context.
 294  * The channel is exclusively allocated and can't be used by another
 295  * client before the owner calls mbox_free_channel.
 296  * After assignment, any packet received on this channel will be
 297  * handed over to the client via the 'rx_callback'.
 298  * The framework holds reference to the client, so the mbox_client
 299  * structure shouldn't be modified until the mbox_free_channel returns.
 300  *
 301  * Return: Pointer to the channel assigned to the client if successful.
 302  *              ERR_PTR for request failure.
 303  */
 304 struct mbox_chan *mbox_request_channel(struct mbox_client *cl, int index)
 305 {
 306         struct device *dev = cl->dev;
 307         struct mbox_controller *mbox;
 308         struct of_phandle_args spec;
 309         struct mbox_chan *chan;
 310         unsigned long flags;
 311         int ret;
 312
 313         if (!dev || !dev->of_node) {
 314                 pr_debug("%s: No owner device node\n", __func__);
 315                 return ERR_PTR(-ENODEV);
 316         }
 317
 318         mutex_lock(&con_mutex);
 319
 320         if (of_parse_phandle_with_args(dev->of_node, "mboxes",
 321                                        "#mbox-cells", index, &spec)) {
 322                 dev_dbg(dev, "%s: can't parse \"mboxes\" property\n", __func__);
 323                 mutex_unlock(&con_mutex);
 324                 return ERR_PTR(-ENODEV);
 325         }
 326
 327         chan = ERR_PTR(-EPROBE_DEFER);
 328         list_for_each_entry(mbox, &mbox_cons, node)
 329                 if (mbox->dev->of_node == spec.np) {
 330                         chan = mbox->of_xlate(mbox, &spec);
 331                         break;
 332                 }
 333
 334         of_node_put(spec.np);
 335
 336         if (IS_ERR(chan)) {
 337                 mutex_unlock(&con_mutex);
 338                 return chan;
 339         }
 340
 341         if (chan->cl || !try_module_get(mbox->dev->driver->owner)) {
 342                 dev_dbg(dev, "%s: mailbox not free\n", __func__);
 343                 mutex_unlock(&con_mutex);
 344                 return ERR_PTR(-EBUSY);
 345         }
 346
 347         spin_lock_irqsave(&chan->lock, flags);
 348         chan->msg_free = 0;
 349         chan->msg_count = 0;
 350         chan->active_req = NULL;
 351         chan->cl = cl;
 352         init_completion(&chan->tx_complete);
 353
 354         if (chan->txdone_method == TXDONE_BY_POLL && cl->knows_txdone)
 355                 chan->txdone_method |= TXDONE_BY_ACK;
 356
 357         spin_unlock_irqrestore(&chan->lock, flags);
 358
 359         ret = chan->mbox->ops->startup(chan);
 360         if (ret) {
 361                 dev_err(dev, "Unable to startup the chan (%d)\n", ret);
 362                 mbox_free_channel(chan);
 363                 chan = ERR_PTR(ret);
 364         }
 365
 366         mutex_unlock(&con_mutex);
 367         return chan;
 368 }
 369 EXPORT_SYMBOL_GPL(mbox_request_channel);
 370
 371 struct mbox_chan *mbox_request_channel_byname(struct mbox_client *cl,
 372                                               const char *name)
 373 {
 374         struct device_node *np = cl->dev->of_node;
 375         struct property *prop;
 376         const char *mbox_name;
 377         int index = 0;
 378
 379         if (!np) {
 380                 dev_err(cl->dev, "%s() currently only supports DT\n", __func__);
 381                 return ERR_PTR(-ENOSYS);
 382         }
 383
 384         if (!of_get_property(np, "mbox-names", NULL)) {
 385                 dev_err(cl->dev,
 386                         "%s() requires an \"mbox-names\" property\n", __func__);
 387                 return ERR_PTR(-ENOSYS);
 388         }
 389
 390         of_property_for_each_string(np, "mbox-names", prop, mbox_name) {
 391                 if (!strncmp(name, mbox_name, strlen(name)))
 392                         return mbox_request_channel(cl, index);
 393                 index++;
 394         }
 395
 396         dev_err(cl->dev, "%s() could not locate channel named \"%s\"\n",
 397                 __func__, name);
 398         return ERR_PTR(-EINVAL);
 399 }
 400 EXPORT_SYMBOL_GPL(mbox_request_channel_byname);
 401
 402 /**
 403  * mbox_free_channel - The client relinquishes control of a mailbox
 404  *                      channel by this call.
 405  * @chan: The mailbox channel to be freed.
 406  */
 407 void mbox_free_channel(struct mbox_chan *chan)
 408 {
 409         unsigned long flags;
 410
 411         if (!chan || !chan->cl)
 412                 return;
 413
 414         chan->mbox->ops->shutdown(chan);
 415
 416         /* The queued TX requests are simply aborted, no callbacks are made */
 417         spin_lock_irqsave(&chan->lock, flags);
 418         chan->cl = NULL;
 419         chan->active_req = NULL;
 420         if (chan->txdone_method == (TXDONE_BY_POLL | TXDONE_BY_ACK))
 421                 chan->txdone_method = TXDONE_BY_POLL;
 422
 423         module_put(chan->mbox->dev->driver->owner);
 424         spin_unlock_irqrestore(&chan->lock, flags);
 425 }
 426 EXPORT_SYMBOL_GPL(mbox_free_channel);
 427
 428 static struct mbox_chan *
 429 of_mbox_index_xlate(struct mbox_controller *mbox,
 430                     const struct of_phandle_args *sp)
 431 {
 432         int ind = sp->args[0];
 433
 434         if (ind >= mbox->num_chans)
 435                 return ERR_PTR(-EINVAL);
 436
 437         return &mbox->chans[ind];
 438 }
 439
 440 /**
 441  * mbox_controller_register - Register the mailbox controller
 442  * @mbox:       Pointer to the mailbox controller.
 443  *
 444  * The controller driver registers its communication channels
 445  */
 446 int mbox_controller_register(struct mbox_controller *mbox)
 447 {
 448         int i, txdone;
 449
 450         /* Sanity check */
 451         if (!mbox || !mbox->dev || !mbox->ops || !mbox->num_chans)
 452                 return -EINVAL;
 453
 454         if (mbox->txdone_irq)
 455                 txdone = TXDONE_BY_IRQ;
 456         else if (mbox->txdone_poll)
 457                 txdone = TXDONE_BY_POLL;
 458         else /* It has to be ACK then */
 459                 txdone = TXDONE_BY_ACK;
 460
 461         if (txdone == TXDONE_BY_POLL) {
 462                 hrtimer_init(&mbox->poll_hrt, CLOCK_MONOTONIC,
 463                              HRTIMER_MODE_REL);
 464                 mbox->poll_hrt.function = txdone_hrtimer;
 465         }
 466
 467         for (i = 0; i < mbox->num_chans; i++) {
 468                 struct mbox_chan *chan = &mbox->chans[i];
 469
 470                 chan->cl = NULL;
 471                 chan->mbox = mbox;
 472                 chan->txdone_method = txdone;
 473                 spin_lock_init(&chan->lock);
 474         }
 475
 476         if (!mbox->of_xlate)
 477                 mbox->of_xlate = of_mbox_index_xlate;
 478
 479         mutex_lock(&con_mutex);
 480         list_add_tail(&mbox->node, &mbox_cons);
 481         mutex_unlock(&con_mutex);
 482
 483         return 0;
 484 }
 485 EXPORT_SYMBOL_GPL(mbox_controller_register);
 486
 487 /**
 488  * mbox_controller_unregister - Unregister the mailbox controller
 489  * @mbox:       Pointer to the mailbox controller.
 490  */
 491 void mbox_controller_unregister(struct mbox_controller *mbox)
 492 {
 493         int i;
 494
 495         if (!mbox)
 496                 return;
 497
 498         mutex_lock(&con_mutex);
 499
 500         list_del(&mbox->node);
 501
 502         for (i = 0; i < mbox->num_chans; i++)
 503                 mbox_free_channel(&mbox->chans[i]);
 504
 505         if (mbox->txdone_poll)
 506                 hrtimer_cancel(&mbox->poll_hrt);
 507
 508         mutex_unlock(&con_mutex);
 509 }
 510 EXPORT_SYMBOL_GPL(mbox_controller_unregister);