1/*
  2 * remote processor messaging bus internals
  3 *
  4 * Copyright (C) 2011 Texas Instruments, Inc.
  5 * Copyright (C) 2011 Google, Inc.
  6 *
  7 * Ohad Ben-Cohen <ohad@wizery.com>
  8 * Brian Swetland <swetland@google.com>
  9 *
 10 * This software is licensed under the terms of the GNU General Public
 11 * License version 2, as published by the Free Software Foundation, and
 12 * may be copied, distributed, and modified under those terms.
 13 *
 14 * This program is distributed in the hope that it will be useful,
 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 17 * GNU General Public License for more details.
 18 */
 19
 20#ifndef __RPMSG_INTERNAL_H__
 21#define __RPMSG_INTERNAL_H__
 22
 23#include <linux/rpmsg.h>
 24#include <linux/poll.h>
 25
 26#define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
 27#define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)
 28
 29/**
 30 * struct rpmsg_device_ops - indirection table for the rpmsg_device operations
 31 * @create_ept:		create backend-specific endpoint, requried
 32 * @announce_create:	announce presence of new channel, optional
 33 * @announce_destroy:	announce destruction of channel, optional
 34 *
 35 * Indirection table for the operations that a rpmsg backend should implement.
 36 * @announce_create and @announce_destroy are optional as the backend might
 37 * advertise new channels implicitly by creating the endpoints.
 38 */
 39struct rpmsg_device_ops {
 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 *ept);
 45	int (*announce_destroy)(struct rpmsg_device *ept);
 46};
 47
 48/**
 49 * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
 50 * @destroy_ept:	destroy the given endpoint, required
 51 * @send:		see @rpmsg_send(), required
 52 * @sendto:		see @rpmsg_sendto(), optional
 53 * @send_offchannel:	see @rpmsg_send_offchannel(), optional
 54 * @trysend:		see @rpmsg_trysend(), required
 55 * @trysendto:		see @rpmsg_trysendto(), optional
 56 * @trysend_offchannel:	see @rpmsg_trysend_offchannel(), optional
 57 *
 58 * Indirection table for the operations that a rpmsg backend should implement.
 59 * In addition to @destroy_ept, the backend must at least implement @send and
 60 * @trysend, while the variants sending data off-channel are optional.
 61 */
 62struct rpmsg_endpoint_ops {
 63	void (*destroy_ept)(struct rpmsg_endpoint *ept);
 64
 65	int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
 66	int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
 67	int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
 68				  void *data, int len);
 69
 70	int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
 71	int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
 72	int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
 73			     void *data, int len);
 74	__poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
 75			     poll_table *wait);
 76};
 77
 78int rpmsg_register_device(struct rpmsg_device *rpdev);
 79int rpmsg_unregister_device(struct device *parent,
 80			    struct rpmsg_channel_info *chinfo);
 81
 82struct device *rpmsg_find_device(struct device *parent,
 83				 struct rpmsg_channel_info *chinfo);
 84
 85/**
 86 * rpmsg_chrdev_register_device() - register chrdev device based on rpdev
 87 * @rpdev:	prepared rpdev to be used for creating endpoints
 88 *
 89 * This function wraps rpmsg_register_device() preparing the rpdev for use as
 90 * basis for the rpmsg chrdev.
 91 */
 92static inline int rpmsg_chrdev_register_device(struct rpmsg_device *rpdev)
 93{
 94	strcpy(rpdev->id.name, "rpmsg_chrdev");
 95	rpdev->driver_override = "rpmsg_chrdev";
 96
 97	return rpmsg_register_device(rpdev);
 98}
 99
100#endif