LXR linux/drivers/rpmsg/rpmsg

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   3 * remote processor messaging bus internals
   4 *
   5 * Copyright (C) 2011 Texas Instruments, Inc.
   6 * Copyright (C) 2011 Google, Inc.
   7 *
   8 * Ohad Ben-Cohen <ohad@wizery.com>
   9 * Brian Swetland <swetland@google.com>
  10 */
  11
  12#ifndef __RPMSG_INTERNAL_H__
  13#define __RPMSG_INTERNAL_H__
  14
  15#include <linux/rpmsg.h>
  16#include <linux/poll.h>
  17
  18#define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
  19#define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)
  20
  21/**
  22 * struct rpmsg_device_ops - indirection table for the rpmsg_device operations
  23 * @create_channel:     create backend-specific channel, optional
  24 * @release_channel:    release backend-specific channel, optional
  25 * @create_ept:         create backend-specific endpoint, required
  26 * @announce_create:    announce presence of new channel, optional
  27 * @announce_destroy:   announce destruction of channel, optional
  28 *
  29 * Indirection table for the operations that a rpmsg backend should implement.
  30 * @announce_create and @announce_destroy are optional as the backend might
  31 * advertise new channels implicitly by creating the endpoints.
  32 */
  33struct rpmsg_device_ops {
  34        struct rpmsg_device *(*create_channel)(struct rpmsg_device *rpdev,
  35                                               struct rpmsg_channel_info *chinfo);
  36        int (*release_channel)(struct rpmsg_device *rpdev,
  37                               struct rpmsg_channel_info *chinfo);
  38        struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
  39                                            rpmsg_rx_cb_t cb, void *priv,
  40                                            struct rpmsg_channel_info chinfo);
  41
  42        int (*announce_create)(struct rpmsg_device *ept);
  43        int (*announce_destroy)(struct rpmsg_device *ept);
  44};
  45
  46/**
  47 * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
  48 * @destroy_ept:        see @rpmsg_destroy_ept(), required
  49 * @send:               see @rpmsg_send(), required
  50 * @sendto:             see @rpmsg_sendto(), optional
  51 * @send_offchannel:    see @rpmsg_send_offchannel(), optional
  52 * @trysend:            see @rpmsg_trysend(), required
  53 * @trysendto:          see @rpmsg_trysendto(), optional
  54 * @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional
  55 * @poll:               see @rpmsg_poll(), optional
  56 *
  57 * Indirection table for the operations that a rpmsg backend should implement.
  58 * In addition to @destroy_ept, the backend must at least implement @send and
  59 * @trysend, while the variants sending data off-channel are optional.
  60 */
  61struct rpmsg_endpoint_ops {
  62        void (*destroy_ept)(struct rpmsg_endpoint *ept);
  63
  64        int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
  65        int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
  66        int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
  67                                  void *data, int len);
  68
  69        int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
  70        int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
  71        int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
  72                             void *data, int len);
  73        __poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
  74                             poll_table *wait);
  75};
  76
  77struct device *rpmsg_find_device(struct device *parent,
  78                                 struct rpmsg_channel_info *chinfo);
  79
  80struct rpmsg_device *rpmsg_create_channel(struct rpmsg_device *rpdev,
  81                                          struct rpmsg_channel_info *chinfo);
  82int rpmsg_release_channel(struct rpmsg_device *rpdev,
  83                          struct rpmsg_channel_info *chinfo);
  84/**
  85 * rpmsg_chrdev_register_device() - register chrdev device based on rpdev
  86 * @rpdev:      prepared rpdev to be used for creating endpoints
  87 *
  88 * This function wraps rpmsg_register_device() preparing the rpdev for use as
  89 * basis for the rpmsg chrdev.
  90 */
  91static inline int rpmsg_chrdev_register_device(struct rpmsg_device *rpdev)
  92{
  93        strcpy(rpdev->id.name, "rpmsg_chrdev");
  94        rpdev->driver_override = "rpmsg_chrdev";
  95
  96        return rpmsg_register_device(rpdev);
  97}
  98
  99#endif
 100