103 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2/*3 * remote processor messaging bus internals4 *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_const(d, struct rpmsg_driver, drv)20 21extern const struct class rpmsg_class;22 23/**24 * struct rpmsg_device_ops - indirection table for the rpmsg_device operations25 * @create_channel: create backend-specific channel, optional26 * @release_channel: release backend-specific channel, optional27 * @create_ept: create backend-specific endpoint, required28 * @announce_create: announce presence of new channel, optional29 * @announce_destroy: announce destruction of channel, optional30 *31 * Indirection table for the operations that a rpmsg backend should implement.32 * @announce_create and @announce_destroy are optional as the backend might33 * advertise new channels implicitly by creating the endpoints.34 */35struct rpmsg_device_ops {36 struct rpmsg_device *(*create_channel)(struct rpmsg_device *rpdev,37 struct rpmsg_channel_info *chinfo);38 int (*release_channel)(struct rpmsg_device *rpdev,39 struct rpmsg_channel_info *chinfo);40 struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,41 rpmsg_rx_cb_t cb, void *priv,42 struct rpmsg_channel_info chinfo);43 44 int (*announce_create)(struct rpmsg_device *rpdev);45 int (*announce_destroy)(struct rpmsg_device *rpdev);46};47 48/**49 * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations50 * @destroy_ept: see @rpmsg_destroy_ept(), required51 * @send: see @rpmsg_send(), required52 * @sendto: see @rpmsg_sendto(), optional53 * @send_offchannel: see @rpmsg_send_offchannel(), optional54 * @trysend: see @rpmsg_trysend(), required55 * @trysendto: see @rpmsg_trysendto(), optional56 * @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional57 * @poll: see @rpmsg_poll(), optional58 * @set_flow_control: see @rpmsg_set_flow_control(), optional59 * @get_mtu: see @rpmsg_get_mtu(), optional60 *61 * Indirection table for the operations that a rpmsg backend should implement.62 * In addition to @destroy_ept, the backend must at least implement @send and63 * @trysend, while the variants sending data off-channel are optional.64 */65struct rpmsg_endpoint_ops {66 void (*destroy_ept)(struct rpmsg_endpoint *ept);67 68 int (*send)(struct rpmsg_endpoint *ept, void *data, int len);69 int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);70 int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,71 void *data, int len);72 73 int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);74 int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);75 int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,76 void *data, int len);77 __poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,78 poll_table *wait);79 int (*set_flow_control)(struct rpmsg_endpoint *ept, bool pause, u32 dst);80 ssize_t (*get_mtu)(struct rpmsg_endpoint *ept);81};82 83struct device *rpmsg_find_device(struct device *parent,84 struct rpmsg_channel_info *chinfo);85 86struct rpmsg_device *rpmsg_create_channel(struct rpmsg_device *rpdev,87 struct rpmsg_channel_info *chinfo);88int rpmsg_release_channel(struct rpmsg_device *rpdev,89 struct rpmsg_channel_info *chinfo);90/**91 * rpmsg_ctrldev_register_device() - register a char device for control based on rpdev92 * @rpdev: prepared rpdev to be used for creating endpoints93 *94 * This function wraps rpmsg_register_device() preparing the rpdev for use as95 * basis for the rpmsg chrdev.96 */97static inline int rpmsg_ctrldev_register_device(struct rpmsg_device *rpdev)98{99 return rpmsg_register_device_override(rpdev, "rpmsg_ctrl");100}101 102#endif103