rpmsg: remote_device: use hil_vdev_notify for remote_dev notify
[processor-sdk/open-amp.git] / 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  */
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  **************************************************************************/
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"
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
63 /* Local functions */
64 static int rpmsg_rdev_init_channels(struct remote_device *rdev);
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 };
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 {
101         struct remote_device *rdev_loc;
102         struct virtio_device *virt_dev;
103         struct proc_shm *shm;
104         int status;
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;
112         /* Create software representation of remote processor. */
113         rdev_loc = (struct remote_device *)metal_allocate_memory(sizeof(struct remote_device));
115         if (!rdev_loc) {
116                 return RPMSG_ERR_NO_MEM;
117         }
119         memset(rdev_loc, 0x00, sizeof(struct remote_device));
120         metal_mutex_init(&rdev_loc->lock);
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;
128         /* Restrict the ept address - zero address can't be assigned */
129         rdev_loc->bitmap[0] = 1;
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         }
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);
149                 if (!rdev_loc->mem_pool) {
150                         return RPMSG_ERR_NO_MEM;
151                 }
152         }
154         if (!rpmsg_rdev_remote_ready(rdev_loc))
155                 return RPMSG_ERR_DEV_INIT;
157         /* Initialize endpoints list */
158         metal_list_init(&rdev_loc->rp_endpoints);
160         /* Initialize channels for RPMSG Remote */
161         status = rpmsg_rdev_init_channels(rdev_loc);
163         if (status != RPMSG_SUCCESS) {
164                 return status;
165         }
167         *rdev = rdev_loc;
169         return RPMSG_SUCCESS;
172 /**
173  * rpmsg_rdev_deinit
174  *
175  * This function un-initializes the remote device.
176  *
177  * @param rdev - pointer to remote device to deinit.
178  *
179  * @return - none
180  *
181  */
182 void rpmsg_rdev_deinit(struct remote_device *rdev)
184         struct metal_list *node;
185         struct rpmsg_channel *rp_chnl;
186         struct rpmsg_endpoint *rp_ept;
189         while(!metal_list_is_empty(&rdev->rp_channels)) {
190                 node = rdev->rp_channels.next;
191                 rp_chnl = metal_container_of(node, struct rpmsg_channel, node);
193                 if (rdev->channel_destroyed) {
194                         rdev->channel_destroyed(rp_chnl);
195                 }
197                 if ((rdev->support_ns) && (rdev->role == RPMSG_MASTER)) {
198                         rpmsg_send_ns_message(rdev, rp_chnl, RPMSG_NS_DESTROY);
199                 }
201                 /* Delete default endpoint for channel */
202                 if (rp_chnl->rp_ept) {
203                         rpmsg_destroy_ept(rp_chnl->rp_ept);
204                 }
206                 _rpmsg_delete_channel(rp_chnl);
207         }
209         /* Delete name service endpoint */
210         metal_mutex_acquire(&rdev->lock);
211         rp_ept = rpmsg_rdev_get_endpoint_from_addr(rdev, RPMSG_NS_EPT_ADDR);
212         metal_mutex_release(&rdev->lock);
213         if (rp_ept) {
214                 _destroy_endpoint(rdev, rp_ept);
215         }
217         metal_mutex_acquire(&rdev->lock);
218         rdev->rvq = 0;
219         rdev->tvq = 0;
220         if (rdev->mem_pool) {
221                 sh_mem_delete_pool(rdev->mem_pool);
222                 rdev->mem_pool = 0;
223         }
224         metal_mutex_release(&rdev->lock);
225         hil_free_vqs(&rdev->virt_dev);
227         if (rdev->proc) {
228                 hil_delete_proc(rdev->proc);
229                 rdev->proc = 0;
230         }
231         metal_mutex_deinit(&rdev->lock);
233         metal_free_memory(rdev);
236 /**
237  * rpmsg_rdev_get_chnl_from_id
238  *
239  * This function returns channel node based on channel name. It must be called
240  * with mutex locked.
241  *
242  * @param stack      - pointer to remote device
243  * @param rp_chnl_id - rpmsg channel name
244  *
245  * @return - rpmsg channel
246  *
247  */
248 struct rpmsg_channel *rpmsg_rdev_get_chnl_from_id(struct remote_device *rdev,
249                                                char *rp_chnl_id)
251         struct rpmsg_channel *rp_chnl;
252         struct metal_list *node;
254         metal_list_for_each(&rdev->rp_channels, node) {
255                 rp_chnl = metal_container_of(node, struct rpmsg_channel, node);
256                 if (strncmp
257                     (rp_chnl->name, rp_chnl_id, sizeof(rp_chnl->name))
258                     == 0) {
259                         return rp_chnl;
260                 }
261         }
263         return RPMSG_NULL;
266 /**
267  * rpmsg_rdev_get_endpoint_from_addr
268  *
269  * This function returns endpoint node based on src address. It must be called
270  * with mutex locked.
271  *
272  * @param rdev - pointer remote device control block
273  * @param addr - src address
274  *
275  * @return - rpmsg endpoint
276  *
277  */
278 struct rpmsg_endpoint *rpmsg_rdev_get_endpoint_from_addr(struct remote_device *rdev,
279                                                 unsigned long addr)
281         struct rpmsg_endpoint *rp_ept;
282         struct metal_list *node;
284         metal_list_for_each(&rdev->rp_endpoints, node) {
285                 rp_ept = metal_container_of(node,
286                                 struct rpmsg_endpoint, node);
287                 if (rp_ept->addr == addr) {
288                         return rp_ept;
289                 }
290         }
292         return RPMSG_NULL;
295 /*
296  * rpmsg_rdev_notify
297  *
298  * This function checks whether remote device is up or not. If it is up then
299  * notification is sent based on device role to start IPC.
300  *
301  * @param rdev - pointer to remote device
302  *
303  * @return - status of function execution
304  *
305  */
306 int rpmsg_rdev_notify(struct remote_device *rdev)
308         struct virtio_device *vdev = &rdev->virt_dev;
310         hil_vdev_notify(vdev);
312         return RPMSG_SUCCESS;
315 /**
316  * rpmsg_rdev_init_channels
317  *
318  * This function is only applicable to RPMSG remote. It obtains channel IDs
319  * from the HIL and creates RPMSG channels corresponding to each ID.
320  *
321  * @param rdev - pointer to remote device
322  *
323  * @return  - status of function execution
324  *
325  */
326 int rpmsg_rdev_init_channels(struct remote_device *rdev)
328         struct rpmsg_channel *rp_chnl;
329         struct proc_chnl *chnl_info;
330         int num_chnls, idx;
332         metal_list_init(&rdev->rp_channels);
333         if (rdev->role == RPMSG_MASTER) {
335                 chnl_info = hil_get_chnl_info(rdev->proc, &num_chnls);
336                 for (idx = 0; idx < num_chnls; idx++) {
338                         rp_chnl =
339                             _rpmsg_create_channel(rdev, chnl_info[idx].name,
340                                                   0x00, RPMSG_NS_EPT_ADDR);
341                         if (!rp_chnl) {
342                                 return RPMSG_ERR_NO_MEM;
343                         }
345                         rp_chnl->rp_ept =
346                             rpmsg_create_ept(rp_chnl, rdev->default_cb, rdev,
347                                              RPMSG_ADDR_ANY);
349                         if (!rp_chnl->rp_ept) {
350                                 return RPMSG_ERR_NO_MEM;
351                         }
353                         rp_chnl->src = rp_chnl->rp_ept->addr;
354                 }
355         }
357         return RPMSG_SUCCESS;
360 /**
361  * check if the remote is ready to start RPMsg communication
362  */
363 int rpmsg_rdev_remote_ready(struct remote_device *rdev)
365         struct virtio_device *vdev = &rdev->virt_dev;
366         uint8_t status;
367         if (rdev->role == RPMSG_MASTER) {
368                 while (1) {
369                         /* Busy wait until the remote is ready */
370                         status = vdev->func->get_status(vdev);
371                         if (status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
372                                 return true;
373                         metal_cpu_yield();
374                 }
375         } else {
376                 return true;
377         }
378         /* Never come here */
379         return false;
382 static void rpmsg_memset_io(struct metal_io_region *io, void *dst, int c, size_t count)
384         if ((io->mem_flags & METAL_IO_MAPPED)) {
385                 metal_memset_io(dst, c, count);
386         } else {
387                 memset(dst, c, count);
388         }
391 /**
392  *------------------------------------------------------------------------
393  * The rest of the file implements the virtio device interface as defined
394  * by the virtio.h file.
395  *------------------------------------------------------------------------
396  */
397 int rpmsg_rdev_create_virtqueues(struct virtio_device *dev, int flags, int nvqs,
398                                  const char *names[], vq_callback * callbacks[],
399                                  struct virtqueue *vqs_[])
401         struct remote_device *rdev;
402         struct vring_alloc_info ring_info;
403         struct virtqueue *vqs[RPMSG_MAX_VQ_PER_RDEV];
404         struct proc_vring *vring_table;
405         void *buffer;
406         struct metal_sg sg;
407         int idx, num_vrings, status;
409         (void)flags;
410         (void)vqs_;
412         rdev = (struct remote_device *)dev;
414         /* Get the vring HW info for the given virtio device */
415         vring_table = hil_get_vring_info(&rdev->proc->vdev, &num_vrings);
417         if (num_vrings > nvqs) {
418                 return RPMSG_ERR_MAX_VQ;
419         }
421         /* Create virtqueue for each vring. */
422         for (idx = 0; idx < num_vrings; idx++) {
424                 INIT_VRING_ALLOC_INFO(ring_info, vring_table[idx]);
426                 if (rdev->role == RPMSG_REMOTE) {
427                         rpmsg_memset_io(vring_table[idx].io, (void *)ring_info.vaddr, 0x00,
428                                vring_size(vring_table[idx].num_descs, vring_table[idx].align));
429                 }
431                 status =
432                     virtqueue_create(dev, idx, (char *)names[idx], &ring_info,
433                                      callbacks[idx], hil_vring_notify,
434                                     rdev->proc->sh_buff.io,
435                                      &vqs[idx]);
437                 if (status != RPMSG_SUCCESS) {
438                         return status;
439                 }
440         }
442         //FIXME - a better way to handle this , tx for master is rx for remote and vice versa.
443         if (rdev->role == RPMSG_MASTER) {
444                 rdev->tvq = vqs[0];
445                 rdev->rvq = vqs[1];
446         } else {
447                 rdev->tvq = vqs[1];
448                 rdev->rvq = vqs[0];
449         }
451         if (rdev->role == RPMSG_REMOTE) {
452                 sg.io = rdev->proc->sh_buff.io;
453                 sg.len = RPMSG_BUFFER_SIZE;
454                 for (idx = 0; ((idx < rdev->rvq->vq_nentries)
455                                && (idx < rdev->mem_pool->total_buffs / 2));
456                      idx++) {
458                         /* Initialize TX virtqueue buffers for remote device */
459                         buffer = sh_mem_get_buffer(rdev->mem_pool);
461                         if (!buffer) {
462                                 return RPMSG_ERR_NO_BUFF;
463                         }
465                         sg.virt = buffer;
467                         rpmsg_memset_io(sg.io, buffer, 0x00, RPMSG_BUFFER_SIZE);
468                         status =
469                             virtqueue_add_buffer(rdev->rvq, &sg, 0, 1,
470                                                  buffer);
472                         if (status != RPMSG_SUCCESS) {
473                                 return status;
474                         }
475                 }
476         }
478         return RPMSG_SUCCESS;
481 unsigned char rpmsg_rdev_get_status(struct virtio_device *dev)
483         struct hil_proc *proc = dev->device;
484         struct proc_vdev *pvdev = &proc->vdev;
485         struct fw_rsc_vdev *vdev_rsc = pvdev->vdev_info;
487         if (!vdev_rsc)
488                 return -1;
490         return vdev_rsc->status;
493 void rpmsg_rdev_set_status(struct virtio_device *dev, unsigned char status)
495         struct hil_proc *proc = dev->device;
496         struct proc_vdev *pvdev = &proc->vdev;
497         struct fw_rsc_vdev *vdev_rsc = pvdev->vdev_info;
499         if (!vdev_rsc)
500                 return;
502         vdev_rsc->status = status;
504         atomic_thread_fence(memory_order_seq_cst);
507 uint32_t rpmsg_rdev_get_feature(struct virtio_device *dev)
509         return dev->features;
512 void rpmsg_rdev_set_feature(struct virtio_device *dev, uint32_t feature)
514         dev->features |= feature;
517 uint32_t rpmsg_rdev_negotiate_feature(struct virtio_device *dev,
518                                       uint32_t features)
520         (void)dev;
521         (void)features;
523         return 0;
526 /*
527  * Read/write a variable amount from the device specific (ie, network)
528  * configuration region. This region is encoded in the same endian as
529  * the guest.
530  */
531 void rpmsg_rdev_read_config(struct virtio_device *dev, uint32_t offset,
532                             void *dst, int length)
534         (void)dev;
535         (void)offset;
536         (void)dst;
537         (void)length;
539         return;
542 void rpmsg_rdev_write_config(struct virtio_device *dev, uint32_t offset,
543                              void *src, int length)
545         (void)dev;
546         (void)offset;
547         (void)src;
548         (void)length;
550         return;
553 void rpmsg_rdev_reset(struct virtio_device *dev)
555         (void)dev;
557         return;