lib/rpmsg/remote_device.c

   1 /*
   2  * Copyright (c) 2014, Mentor Graphics Corporation
   3  * All rights reserved.
   4  * Copyright (c) 2015 Xilinx, Inc. All rights reserved.
   5  * Copyright (c) 2016 Freescale Semiconductor, Inc. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright notice,
  11  *    this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright notice,
  13  *    this list of conditions and the following disclaimer in the documentation
  14  *    and/or other materials provided with the distribution.
  15  * 3. Neither the name of Mentor Graphics Corporation nor the names of its
  16  *    contributors may be used to endorse or promote products derived from this
  17  *    software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /**************************************************************************
  33  * FILE NAME
  34  *
  35  *       remote_device.c
  36  *
  37  * COMPONENT
  38  *
  39  *       OpenAMP Stack
  40  *
  41  * DESCRIPTION
  42  *
  43  * This file provides services to manage the remote devices.It also implements
  44  * the interface defined by the virtio and provides few other utility functions.
  45  *
  46  *
  47  **************************************************************************/
  48
  49 #include <string.h>
  50 #include "openamp/rpmsg.h"
  51 #include "openamp/remoteproc.h"
  52 #include "metal/utilities.h"
  53 #include "metal/alloc.h"
  54 #include "metal/atomic.h"
  55 #include "metal/cpu.h"
  56
  57 /* Macro to initialize vring HW info */
  58 #define INIT_VRING_ALLOC_INFO(ring_info,vring_hw)                             \
  59                          (ring_info).vaddr  = (vring_hw).vaddr;               \
  60                          (ring_info).align     = (vring_hw).align;             \
  61                          (ring_info).num_descs = (vring_hw).num_descs
  62
  63 /* Local functions */
  64 static int rpmsg_rdev_init_channels(struct remote_device *rdev);
  65
  66 /* Ops table for virtio device */
  67 virtio_dispatch rpmsg_rdev_config_ops = {
  68         rpmsg_rdev_create_virtqueues,
  69         rpmsg_rdev_get_status,
  70         rpmsg_rdev_set_status,
  71         rpmsg_rdev_get_feature,
  72         rpmsg_rdev_set_feature,
  73         rpmsg_rdev_negotiate_feature,
  74         rpmsg_rdev_read_config,
  75         rpmsg_rdev_write_config,
  76         rpmsg_rdev_reset
  77 };
  78
  79 /**
  80  * rpmsg_rdev_init
  81  *
  82  * This function creates and initializes the remote device. The remote device
  83  * encapsulates virtio device.
  84  *
  85  * @param proc              - pointer to hil_proc
  86  * @param rdev              - pointer to newly created remote device
  87  * @param role              - role of the other device, Master or Remote
  88  * @param channel_created   - callback function for channel creation
  89  * @param channel_destroyed - callback function for channel deletion
  90  * @param default_cb        - default callback for channel
  91  *
  92  * @return - status of function execution
  93  *
  94  */
  95 int rpmsg_rdev_init(struct hil_proc *proc,
  96                     struct remote_device **rdev, int role,
  97                     rpmsg_chnl_cb_t channel_created,
  98                     rpmsg_chnl_cb_t channel_destroyed, rpmsg_rx_cb_t default_cb)
  99 {
 100
 101         struct remote_device *rdev_loc;
 102         struct virtio_device *virt_dev;
 103         struct proc_shm *shm;
 104         int status;
 105
 106         if (!proc)
 107                 return RPMSG_ERR_PARAM;
 108         /* Initialize HIL data structures for given device */
 109         if (hil_init_proc(proc))
 110                 return RPMSG_ERR_DEV_INIT;
 111
 112         /* Create software representation of remote processor. */
 113         rdev_loc = (struct remote_device *)metal_allocate_memory(sizeof(struct remote_device));
 114
 115         if (!rdev_loc) {
 116                 return RPMSG_ERR_NO_MEM;
 117         }
 118
 119         memset(rdev_loc, 0x00, sizeof(struct remote_device));
 120         metal_mutex_init(&rdev_loc->lock);
 121
 122         rdev_loc->proc = proc;
 123         rdev_loc->role = role;
 124         rdev_loc->channel_created = channel_created;
 125         rdev_loc->channel_destroyed = channel_destroyed;
 126         rdev_loc->default_cb = default_cb;
 127
 128         /* Restrict the ept address - zero address can't be assigned */
 129         rdev_loc->bitmap[0] = 1;
 130
 131         /* Initialize the virtio device */
 132         virt_dev = &rdev_loc->virt_dev;
 133         virt_dev->device = proc;
 134         virt_dev->func = &rpmsg_rdev_config_ops;
 135         if (virt_dev->func->set_features != RPMSG_NULL) {
 136                 virt_dev->func->set_features(virt_dev, proc->vdev.dfeatures);
 137         }
 138
 139         if (rdev_loc->role == RPMSG_REMOTE) {
 140                 /*
 141                  * Since device is RPMSG Remote so we need to manage the
 142                  * shared buffers. Create shared memory pool to handle buffers.
 143                  */
 144                 shm = hil_get_shm_info(proc);
 145                 rdev_loc->mem_pool =
 146                     sh_mem_create_pool(shm->start_addr, shm->size,
 147                                        RPMSG_BUFFER_SIZE);
 148
 149                 if (!rdev_loc->mem_pool) {
 150                         return RPMSG_ERR_NO_MEM;
 151                 }
 152         }
 153
 154         /* Initialize endpoints list */
 155         metal_list_init(&rdev_loc->rp_endpoints);
 156
 157         /* Initialize channels for RPMSG Remote */
 158         status = rpmsg_rdev_init_channels(rdev_loc);
 159
 160         if (status != RPMSG_SUCCESS) {
 161                 return status;
 162         }
 163
 164         *rdev = rdev_loc;
 165
 166         return RPMSG_SUCCESS;
 167 }
 168
 169 /**
 170  * rpmsg_rdev_deinit
 171  *
 172  * This function un-initializes the remote device.
 173  *
 174  * @param rdev - pointer to remote device to deinit.
 175  *
 176  * @return - none
 177  *
 178  */
 179 void rpmsg_rdev_deinit(struct remote_device *rdev)
 180 {
 181         struct metal_list *node;
 182         struct rpmsg_channel *rp_chnl;
 183         struct rpmsg_endpoint *rp_ept;
 184
 185
 186         while(!metal_list_is_empty(&rdev->rp_channels)) {
 187                 node = rdev->rp_channels.next;
 188                 rp_chnl = metal_container_of(node, struct rpmsg_channel, node);
 189
 190                 if (rdev->channel_destroyed) {
 191                         rdev->channel_destroyed(rp_chnl);
 192                 }
 193
 194                 if ((rdev->support_ns) && (rdev->role == RPMSG_MASTER)) {
 195                         rpmsg_send_ns_message(rdev, rp_chnl, RPMSG_NS_DESTROY);
 196                 }
 197
 198                 /* Delete default endpoint for channel */
 199                 if (rp_chnl->rp_ept) {
 200                         rpmsg_destroy_ept(rp_chnl->rp_ept);
 201                 }
 202
 203                 _rpmsg_delete_channel(rp_chnl);
 204         }
 205
 206         /* Delete name service endpoint */
 207         metal_mutex_acquire(&rdev->lock);
 208         rp_ept = rpmsg_rdev_get_endpoint_from_addr(rdev, RPMSG_NS_EPT_ADDR);
 209         metal_mutex_release(&rdev->lock);
 210         if (rp_ept) {
 211                 _destroy_endpoint(rdev, rp_ept);
 212         }
 213
 214         if (rdev->rvq) {
 215                 virtqueue_free(rdev->rvq);
 216         }
 217         if (rdev->tvq) {
 218                 virtqueue_free(rdev->tvq);
 219         }
 220         if (rdev->mem_pool) {
 221                 sh_mem_delete_pool(rdev->mem_pool);
 222         }
 223         metal_mutex_deinit(&rdev->lock);
 224         if (rdev->proc) {
 225                 hil_delete_proc(rdev->proc);
 226                 rdev->proc = 0;
 227         }
 228
 229         metal_free_memory(rdev);
 230 }
 231
 232 /**
 233  * rpmsg_rdev_get_chnl_from_id
 234  *
 235  * This function returns channel node based on channel name. It must be called
 236  * with mutex locked.
 237  *
 238  * @param stack      - pointer to remote device
 239  * @param rp_chnl_id - rpmsg channel name
 240  *
 241  * @return - rpmsg channel
 242  *
 243  */
 244 struct rpmsg_channel *rpmsg_rdev_get_chnl_from_id(struct remote_device *rdev,
 245                                                char *rp_chnl_id)
 246 {
 247         struct rpmsg_channel *rp_chnl;
 248         struct metal_list *node;
 249
 250         metal_list_for_each(&rdev->rp_channels, node) {
 251                 rp_chnl = metal_container_of(node, struct rpmsg_channel, node);
 252                 if (strncmp
 253                     (rp_chnl->name, rp_chnl_id, sizeof(rp_chnl->name))
 254                     == 0) {
 255                         return rp_chnl;
 256                 }
 257         }
 258
 259         return RPMSG_NULL;
 260 }
 261
 262 /**
 263  * rpmsg_rdev_get_endpoint_from_addr
 264  *
 265  * This function returns endpoint node based on src address. It must be called
 266  * with mutex locked.
 267  *
 268  * @param rdev - pointer remote device control block
 269  * @param addr - src address
 270  *
 271  * @return - rpmsg endpoint
 272  *
 273  */
 274 struct rpmsg_endpoint *rpmsg_rdev_get_endpoint_from_addr(struct remote_device *rdev,
 275                                                 unsigned long addr)
 276 {
 277         struct rpmsg_endpoint *rp_ept;
 278         struct metal_list *node;
 279
 280         metal_list_for_each(&rdev->rp_endpoints, node) {
 281                 rp_ept = metal_container_of(node,
 282                                 struct rpmsg_endpoint, node);
 283                 if (rp_ept->addr == addr) {
 284                         return rp_ept;
 285                 }
 286         }
 287
 288         return RPMSG_NULL;
 289 }
 290
 291 /*
 292  * rpmsg_rdev_notify
 293  *
 294  * This function checks whether remote device is up or not. If it is up then
 295  * notification is sent based on device role to start IPC.
 296  *
 297  * @param rdev - pointer to remote device
 298  *
 299  * @return - status of function execution
 300  *
 301  */
 302 int rpmsg_rdev_notify(struct remote_device *rdev)
 303 {
 304         int status = RPMSG_SUCCESS;
 305
 306         if (rdev->role == RPMSG_REMOTE) {
 307                 status = hil_get_status(rdev->proc);
 308
 309                 /*
 310                  * Let the remote device know that Master is ready for
 311                  * communication.
 312                  */
 313                 if (!status)
 314                         virtqueue_kick(rdev->rvq);
 315
 316         } else {
 317                 status = hil_set_status(rdev->proc);
 318         }
 319
 320         if (status == RPMSG_SUCCESS) {
 321                 rdev->state = RPMSG_DEV_STATE_ACTIVE;
 322         }
 323
 324         return status;
 325 }
 326
 327 /**
 328  * rpmsg_rdev_init_channels
 329  *
 330  * This function is only applicable to RPMSG remote. It obtains channel IDs
 331  * from the HIL and creates RPMSG channels corresponding to each ID.
 332  *
 333  * @param rdev - pointer to remote device
 334  *
 335  * @return  - status of function execution
 336  *
 337  */
 338 int rpmsg_rdev_init_channels(struct remote_device *rdev)
 339 {
 340         struct rpmsg_channel *rp_chnl;
 341         struct proc_chnl *chnl_info;
 342         int num_chnls, idx;
 343
 344         metal_list_init(&rdev->rp_channels);
 345         if (rdev->role == RPMSG_MASTER) {
 346
 347                 chnl_info = hil_get_chnl_info(rdev->proc, &num_chnls);
 348                 for (idx = 0; idx < num_chnls; idx++) {
 349
 350                         rp_chnl =
 351                             _rpmsg_create_channel(rdev, chnl_info[idx].name,
 352                                                   0x00, RPMSG_NS_EPT_ADDR);
 353                         if (!rp_chnl) {
 354                                 return RPMSG_ERR_NO_MEM;
 355                         }
 356
 357                         rp_chnl->rp_ept =
 358                             rpmsg_create_ept(rp_chnl, rdev->default_cb, rdev,
 359                                              RPMSG_ADDR_ANY);
 360
 361                         if (!rp_chnl->rp_ept) {
 362                                 return RPMSG_ERR_NO_MEM;
 363                         }
 364
 365                         rp_chnl->src = rp_chnl->rp_ept->addr;
 366                 }
 367         }
 368
 369         return RPMSG_SUCCESS;
 370 }
 371
 372 /**
 373  * check if the remote is ready to start RPMsg communication
 374  */
 375 int rpmsg_rdev_remote_ready(struct remote_device *rdev)
 376 {
 377         struct virtio_device *vdev = &rdev->virt_dev;
 378         uint8_t status;
 379         if (rdev->role == RPMSG_MASTER) {
 380                 while (1) {
 381                         /* Busy wait until the remote is ready */
 382                         status = vdev->func->get_status(vdev);
 383                         if (status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
 384                                 return true;
 385                         metal_cpu_yield();
 386                 }
 387         } else {
 388                 return true;
 389         }
 390         /* Never come here */
 391         return false;
 392 }
 393
 394 static void rpmsg_memset_io(struct metal_io_region *io, void *dst, int c, size_t count)
 395 {
 396         if ((io->mem_flags & METAL_IO_MAPPED)) {
 397                 metal_memset_io(dst, c, count);
 398         } else {
 399                 memset(dst, c, count);
 400         }
 401 }
 402
 403 /**
 404  *------------------------------------------------------------------------
 405  * The rest of the file implements the virtio device interface as defined
 406  * by the virtio.h file.
 407  *------------------------------------------------------------------------
 408  */
 409 int rpmsg_rdev_create_virtqueues(struct virtio_device *dev, int flags, int nvqs,
 410                                  const char *names[], vq_callback * callbacks[],
 411                                  struct virtqueue *vqs_[])
 412 {
 413         struct remote_device *rdev;
 414         struct vring_alloc_info ring_info;
 415         struct virtqueue *vqs[RPMSG_MAX_VQ_PER_RDEV];
 416         struct proc_vring *vring_table;
 417         void *buffer;
 418         struct metal_sg sg;
 419         int idx, num_vrings, status;
 420
 421         (void)flags;
 422         (void)vqs_;
 423
 424         rdev = (struct remote_device *)dev;
 425
 426         /* Get the vring HW info for the given virtio device */
 427         vring_table = hil_get_vring_info(&rdev->proc->vdev, &num_vrings);
 428
 429         if (num_vrings > nvqs) {
 430                 return RPMSG_ERR_MAX_VQ;
 431         }
 432
 433         /* Create virtqueue for each vring. */
 434         for (idx = 0; idx < num_vrings; idx++) {
 435
 436                 INIT_VRING_ALLOC_INFO(ring_info, vring_table[idx]);
 437
 438                 if (rdev->role == RPMSG_REMOTE) {
 439                         rpmsg_memset_io(vring_table[idx].io, (void *)ring_info.vaddr, 0x00,
 440                                vring_size(vring_table[idx].num_descs, vring_table[idx].align));
 441                 }
 442
 443                 status =
 444                     virtqueue_create(dev, idx, (char *)names[idx], &ring_info,
 445                                      callbacks[idx], hil_vring_notify,
 446                                     rdev->proc->sh_buff.io,
 447                                      &vqs[idx]);
 448
 449                 if (status != RPMSG_SUCCESS) {
 450                         return status;
 451                 }
 452         }
 453
 454         //FIXME - a better way to handle this , tx for master is rx for remote and vice versa.
 455         if (rdev->role == RPMSG_MASTER) {
 456                 rdev->tvq = vqs[0];
 457                 rdev->rvq = vqs[1];
 458         } else {
 459                 rdev->tvq = vqs[1];
 460                 rdev->rvq = vqs[0];
 461         }
 462
 463         if (rdev->role == RPMSG_REMOTE) {
 464                 sg.io = rdev->proc->sh_buff.io;
 465                 sg.len = RPMSG_BUFFER_SIZE;
 466                 for (idx = 0; ((idx < rdev->rvq->vq_nentries)
 467                                && (idx < rdev->mem_pool->total_buffs / 2));
 468                      idx++) {
 469
 470                         /* Initialize TX virtqueue buffers for remote device */
 471                         buffer = sh_mem_get_buffer(rdev->mem_pool);
 472
 473                         if (!buffer) {
 474                                 return RPMSG_ERR_NO_BUFF;
 475                         }
 476
 477                         sg.virt = buffer;
 478
 479                         rpmsg_memset_io(sg.io, buffer, 0x00, RPMSG_BUFFER_SIZE);
 480                         status =
 481                             virtqueue_add_buffer(rdev->rvq, &sg, 0, 1,
 482                                                  buffer);
 483
 484                         if (status != RPMSG_SUCCESS) {
 485                                 return status;
 486                         }
 487                 }
 488         }
 489
 490         return RPMSG_SUCCESS;
 491 }
 492
 493 unsigned char rpmsg_rdev_get_status(struct virtio_device *dev)
 494 {
 495         struct hil_proc *proc = dev->device;
 496         struct proc_vdev *pvdev = &proc->vdev;
 497         struct fw_rsc_vdev *vdev_rsc = pvdev->vdev_info;
 498
 499         if (!vdev_rsc)
 500                 return -1;
 501
 502         return vdev_rsc->status;
 503 }
 504
 505 void rpmsg_rdev_set_status(struct virtio_device *dev, unsigned char status)
 506 {
 507         struct hil_proc *proc = dev->device;
 508         struct proc_vdev *pvdev = &proc->vdev;
 509         struct fw_rsc_vdev *vdev_rsc = pvdev->vdev_info;
 510
 511         if (!vdev_rsc)
 512                 return;
 513
 514         vdev_rsc->status = status;
 515
 516         atomic_thread_fence(memory_order_seq_cst);
 517 }
 518
 519 uint32_t rpmsg_rdev_get_feature(struct virtio_device *dev)
 520 {
 521         return dev->features;
 522 }
 523
 524 void rpmsg_rdev_set_feature(struct virtio_device *dev, uint32_t feature)
 525 {
 526         dev->features |= feature;
 527 }
 528
 529 uint32_t rpmsg_rdev_negotiate_feature(struct virtio_device *dev,
 530                                       uint32_t features)
 531 {
 532         (void)dev;
 533         (void)features;
 534
 535         return 0;
 536 }
 537
 538 /*
 539  * Read/write a variable amount from the device specific (ie, network)
 540  * configuration region. This region is encoded in the same endian as
 541  * the guest.
 542  */
 543 void rpmsg_rdev_read_config(struct virtio_device *dev, uint32_t offset,
 544                             void *dst, int length)
 545 {
 546         (void)dev;
 547         (void)offset;
 548         (void)dst;
 549         (void)length;
 550
 551         return;
 552 }
 553
 554 void rpmsg_rdev_write_config(struct virtio_device *dev, uint32_t offset,
 555                              void *src, int length)
 556 {
 557         (void)dev;
 558         (void)offset;
 559         (void)src;
 560         (void)length;
 561
 562         return;
 563 }
 564
 565 void rpmsg_rdev_reset(struct virtio_device *dev)
 566 {
 567         (void)dev;
 568
 569         return;
 570 }