a4f64634ad
In order to reduce the amount of copies in the rpmsg framework, it is necessary for clients to take brief ownership of the receive buffer. Add the capability for clients to notify the rpmsg framework and the underlying transports when it is going to hold onto a buffer and also notify when the client is done with the buffer. In the .rx_cb of the rpmsg drivers, if they wish to use the received buffer at a later point, they should return RPMSG_DEFER. Otherwise returning RPMSG_HANDLED (0) will signal the framework that the client is done with the resources and can continue with cleanup. The clients should check if their rpmsg endpoint supports the rx_done operation with the new state variable in the rpmsg_endpoint since not all endpoints will have the ability to support this operation. Bug: 235577039 Link: https://lore.kernel.org/lkml/1654651005-15475-2-git-send-email-quic_clew@quicinc.com/ Change-Id: I008ae73d54f9d8319e9dbcafd7d9c7007fa4f234 Signed-off-by: Chris Lew <quic_clew@quicinc.com>
108 lines
4.0 KiB
C
108 lines
4.0 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* remote processor messaging bus internals
|
|
*
|
|
* Copyright (c) 2020 The Linux Foundation.
|
|
* Copyright (C) 2011 Texas Instruments, Inc.
|
|
* Copyright (C) 2011 Google, Inc.
|
|
*
|
|
* Ohad Ben-Cohen <ohad@wizery.com>
|
|
* Brian Swetland <swetland@google.com>
|
|
*/
|
|
|
|
#ifndef __RPMSG_INTERNAL_H__
|
|
#define __RPMSG_INTERNAL_H__
|
|
|
|
#include <linux/rpmsg.h>
|
|
#include <linux/poll.h>
|
|
|
|
#define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
|
|
#define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)
|
|
|
|
extern struct class *rpmsg_class;
|
|
|
|
/**
|
|
* struct rpmsg_device_ops - indirection table for the rpmsg_device operations
|
|
* @create_channel: create backend-specific channel, optional
|
|
* @release_channel: release backend-specific channel, optional
|
|
* @create_ept: create backend-specific endpoint, required
|
|
* @announce_create: announce presence of new channel, optional
|
|
* @announce_destroy: announce destruction of channel, optional
|
|
*
|
|
* Indirection table for the operations that a rpmsg backend should implement.
|
|
* @announce_create and @announce_destroy are optional as the backend might
|
|
* advertise new channels implicitly by creating the endpoints.
|
|
*/
|
|
struct rpmsg_device_ops {
|
|
struct rpmsg_device *(*create_channel)(struct rpmsg_device *rpdev,
|
|
struct rpmsg_channel_info *chinfo);
|
|
int (*release_channel)(struct rpmsg_device *rpdev,
|
|
struct rpmsg_channel_info *chinfo);
|
|
struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
|
|
rpmsg_rx_cb_t cb, void *priv,
|
|
struct rpmsg_channel_info chinfo);
|
|
|
|
int (*announce_create)(struct rpmsg_device *ept);
|
|
int (*announce_destroy)(struct rpmsg_device *ept);
|
|
};
|
|
|
|
/**
|
|
* struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
|
|
* @destroy_ept: see @rpmsg_destroy_ept(), required
|
|
* @send: see @rpmsg_send(), required
|
|
* @sendto: see @rpmsg_sendto(), optional
|
|
* @send_offchannel: see @rpmsg_send_offchannel(), optional
|
|
* @trysend: see @rpmsg_trysend(), required
|
|
* @trysendto: see @rpmsg_trysendto(), optional
|
|
* @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional
|
|
* @poll: see @rpmsg_poll(), optional
|
|
* @get_signals: see @rpmsg_get_signals(), optional
|
|
* @set_signals: see @rpmsg_set_signals(), optional
|
|
*
|
|
* Indirection table for the operations that a rpmsg backend should implement.
|
|
* In addition to @destroy_ept, the backend must at least implement @send and
|
|
* @trysend, while the variants sending data off-channel are optional.
|
|
*/
|
|
struct rpmsg_endpoint_ops {
|
|
void (*destroy_ept)(struct rpmsg_endpoint *ept);
|
|
|
|
int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
|
|
int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
|
|
int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
|
|
void *data, int len);
|
|
|
|
int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
|
|
int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
|
|
int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
|
|
void *data, int len);
|
|
__poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
|
|
poll_table *wait);
|
|
int (*rx_done)(struct rpmsg_endpoint *ept, void *data);
|
|
int (*get_signals)(struct rpmsg_endpoint *ept);
|
|
int (*set_signals)(struct rpmsg_endpoint *ept, u32 set, u32 clear);
|
|
};
|
|
|
|
struct device *rpmsg_find_device(struct device *parent,
|
|
struct rpmsg_channel_info *chinfo);
|
|
|
|
struct rpmsg_device *rpmsg_create_channel(struct rpmsg_device *rpdev,
|
|
struct rpmsg_channel_info *chinfo);
|
|
int rpmsg_release_channel(struct rpmsg_device *rpdev,
|
|
struct rpmsg_channel_info *chinfo);
|
|
/**
|
|
* rpmsg_ctrldev_register_device() - register a char device for control based on rpdev
|
|
* @rpdev: prepared rpdev to be used for creating endpoints
|
|
*
|
|
* This function wraps rpmsg_register_device() preparing the rpdev for use as
|
|
* basis for the rpmsg chrdev.
|
|
*/
|
|
static inline int rpmsg_ctrldev_register_device(struct rpmsg_device *rpdev)
|
|
{
|
|
strcpy(rpdev->id.name, "rpmsg_ctrl");
|
|
rpdev->driver_override = "rpmsg_ctrl";
|
|
|
|
return rpmsg_register_device(rpdev);
|
|
}
|
|
|
|
#endif
|