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_ept:         create backend-specific endpoint, requried
  24 * @announce_create:    announce presence of new channel, optional
  25 * @announce_destroy:   announce destruction of channel, optional
  26 *
  27 * Indirection table for the operations that a rpmsg backend should implement.
  28 * @announce_create and @announce_destroy are optional as the backend might
  29 * advertise new channels implicitly by creating the endpoints.
  30 */
  31struct rpmsg_device_ops {
  32        struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
  33                                            rpmsg_rx_cb_t cb, void *priv,
  34                                            struct rpmsg_channel_info chinfo);
  35
  36        int (*announce_create)(struct rpmsg_device *ept);
  37        int (*announce_destroy)(struct rpmsg_device *ept);
  38};
  39
  40/**
  41 * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
  42 * @destroy_ept:        destroy the given endpoint, required
  43 * @send:               see @rpmsg_send(), required
  44 * @sendto:             see @rpmsg_sendto(), optional
  45 * @send_offchannel:    see @rpmsg_send_offchannel(), optional
  46 * @trysend:            see @rpmsg_trysend(), required
  47 * @trysendto:          see @rpmsg_trysendto(), optional
  48 * @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional
  49 *
  50 * Indirection table for the operations that a rpmsg backend should implement.
  51 * In addition to @destroy_ept, the backend must at least implement @send and
  52 * @trysend, while the variants sending data off-channel are optional.
  53 */
  54struct rpmsg_endpoint_ops {
  55        void (*destroy_ept)(struct rpmsg_endpoint *ept);
  56
  57        int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
  58        int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
  59        int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
  60                                  void *data, int len);
  61
  62        int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
  63        int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
  64        int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
  65                             void *data, int len);
  66        __poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
  67                             poll_table *wait);
  68};
  69
  70int rpmsg_register_device(struct rpmsg_device *rpdev);
  71int rpmsg_unregister_device(struct device *parent,
  72                            struct rpmsg_channel_info *chinfo);
  73
  74struct device *rpmsg_find_device(struct device *parent,
  75                                 struct rpmsg_channel_info *chinfo);
  76
  77/**
  78 * rpmsg_chrdev_register_device() - register chrdev device based on rpdev
  79 * @rpdev:      prepared rpdev to be used for creating endpoints
  80 *
  81 * This function wraps rpmsg_register_device() preparing the rpdev for use as
  82 * basis for the rpmsg chrdev.
  83 */
  84static inline int rpmsg_chrdev_register_device(struct rpmsg_device *rpdev)
  85{
  86        strcpy(rpdev->id.name, "rpmsg_chrdev");
  87        rpdev->driver_override = "rpmsg_chrdev";
  88
  89        return rpmsg_register_device(rpdev);
  90}
  91
  92#endif
  93