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