2018-06-01 01:10:59 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2016-09-02 06:28:02 +08:00
|
|
|
/*
|
|
|
|
|
* remote processor messaging bus internals
|
|
|
|
|
*
|
|
|
|
|
* 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>
|
2017-01-11 22:35:10 +08:00
|
|
|
#include <linux/poll.h>
|
2016-09-02 06:28:02 +08:00
|
|
|
|
|
|
|
|
#define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
|
2024-07-01 20:07:37 +08:00
|
|
|
#define to_rpmsg_driver(d) container_of_const(d, struct rpmsg_driver, drv)
|
2016-09-02 06:28:02 +08:00
|
|
|
|
2024-03-06 02:28:27 +08:00
|
|
|
extern const struct class rpmsg_class;
|
2022-01-24 18:25:15 +08:00
|
|
|
|
2016-09-02 06:28:05 +08:00
|
|
|
/**
|
|
|
|
|
* struct rpmsg_device_ops - indirection table for the rpmsg_device operations
|
2020-11-21 05:42:42 +08:00
|
|
|
* @create_channel: create backend-specific channel, optional
|
|
|
|
|
* @release_channel: release backend-specific channel, optional
|
2019-02-23 12:20:17 +08:00
|
|
|
* @create_ept: create backend-specific endpoint, required
|
2016-09-02 06:28:05 +08:00
|
|
|
* @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 {
|
2020-11-21 05:42:42 +08:00
|
|
|
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);
|
2016-09-02 06:28:05 +08:00
|
|
|
struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
|
|
|
|
|
rpmsg_rx_cb_t cb, void *priv,
|
|
|
|
|
struct rpmsg_channel_info chinfo);
|
|
|
|
|
|
2022-04-25 15:17:23 +08:00
|
|
|
int (*announce_create)(struct rpmsg_device *rpdev);
|
|
|
|
|
int (*announce_destroy)(struct rpmsg_device *rpdev);
|
2016-09-02 06:28:05 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
|
2019-02-23 12:20:17 +08:00
|
|
|
* @destroy_ept: see @rpmsg_destroy_ept(), required
|
2016-09-02 06:28:05 +08:00
|
|
|
* @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
|
2019-02-23 12:20:17 +08:00
|
|
|
* @poll: see @rpmsg_poll(), optional
|
2023-07-07 05:41:36 +08:00
|
|
|
* @set_flow_control: see @rpmsg_set_flow_control(), optional
|
2021-10-15 17:47:00 +08:00
|
|
|
* @get_mtu: see @rpmsg_get_mtu(), optional
|
2016-09-02 06:28:05 +08:00
|
|
|
*
|
|
|
|
|
* 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);
|
2017-07-03 18:39:46 +08:00
|
|
|
__poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
|
2017-01-11 22:35:10 +08:00
|
|
|
poll_table *wait);
|
2023-07-07 05:41:36 +08:00
|
|
|
int (*set_flow_control)(struct rpmsg_endpoint *ept, bool pause, u32 dst);
|
2021-10-15 17:47:00 +08:00
|
|
|
ssize_t (*get_mtu)(struct rpmsg_endpoint *ept);
|
2016-09-02 06:28:05 +08:00
|
|
|
};
|
|
|
|
|
|
2016-09-02 06:28:02 +08:00
|
|
|
struct device *rpmsg_find_device(struct device *parent,
|
|
|
|
|
struct rpmsg_channel_info *chinfo);
|
|
|
|
|
|
2020-11-21 05:42:42 +08:00
|
|
|
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: Driver for user space endpoint interface
This driver allows rpmsg instances to expose access to rpmsg endpoints
to user space processes. It provides a control interface, allowing
userspace to export endpoints and an endpoint interface for each exposed
endpoint.
The implementation is based on prior art by Texas Instrument, Google,
PetaLogix and was derived from a FreeRTOS performance statistics driver
written by Michal Simek.
The control interface provides a "create endpoint" ioctl, which is fed a
name, source and destination address. The three values are used to
create the endpoint, in a backend-specific way, and a rpmsg endpoint
device is created - with the three parameters are available in sysfs for
udev usage.
E.g. to create an endpoint device for one of the Qualcomm SMD channel
related to DIAG one would issue:
struct rpmsg_endpoint_info info = { "DIAG_CNTL", 0, 0 };
int fd = open("/dev/rpmsg_ctrl0", O_RDWR);
ioctl(fd, RPMSG_CREATE_EPT_IOCTL, &info);
Each created endpoint device shows up as an individual character device
in /dev, allowing permission to be controlled on a per-endpoint basis.
The rpmsg endpoint will be created and destroyed following the opening
and closing of the endpoint device, allowing rpmsg backends to open and
close the physical channel, if supported by the wire protocol.
Cc: Marek Novak <marek.novak@nxp.com>
Cc: Matteo Sartori <matteo.sartori@t3lab.it>
Cc: Michal Simek <monstr@monstr.eu>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2017-01-11 22:35:12 +08:00
|
|
|
/**
|
2022-01-24 18:25:20 +08:00
|
|
|
* rpmsg_ctrldev_register_device() - register a char device for control based on rpdev
|
rpmsg: Driver for user space endpoint interface
This driver allows rpmsg instances to expose access to rpmsg endpoints
to user space processes. It provides a control interface, allowing
userspace to export endpoints and an endpoint interface for each exposed
endpoint.
The implementation is based on prior art by Texas Instrument, Google,
PetaLogix and was derived from a FreeRTOS performance statistics driver
written by Michal Simek.
The control interface provides a "create endpoint" ioctl, which is fed a
name, source and destination address. The three values are used to
create the endpoint, in a backend-specific way, and a rpmsg endpoint
device is created - with the three parameters are available in sysfs for
udev usage.
E.g. to create an endpoint device for one of the Qualcomm SMD channel
related to DIAG one would issue:
struct rpmsg_endpoint_info info = { "DIAG_CNTL", 0, 0 };
int fd = open("/dev/rpmsg_ctrl0", O_RDWR);
ioctl(fd, RPMSG_CREATE_EPT_IOCTL, &info);
Each created endpoint device shows up as an individual character device
in /dev, allowing permission to be controlled on a per-endpoint basis.
The rpmsg endpoint will be created and destroyed following the opening
and closing of the endpoint device, allowing rpmsg backends to open and
close the physical channel, if supported by the wire protocol.
Cc: Marek Novak <marek.novak@nxp.com>
Cc: Matteo Sartori <matteo.sartori@t3lab.it>
Cc: Michal Simek <monstr@monstr.eu>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2017-01-11 22:35:12 +08:00
|
|
|
* @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.
|
|
|
|
|
*/
|
2022-01-24 18:25:20 +08:00
|
|
|
static inline int rpmsg_ctrldev_register_device(struct rpmsg_device *rpdev)
|
rpmsg: Driver for user space endpoint interface
This driver allows rpmsg instances to expose access to rpmsg endpoints
to user space processes. It provides a control interface, allowing
userspace to export endpoints and an endpoint interface for each exposed
endpoint.
The implementation is based on prior art by Texas Instrument, Google,
PetaLogix and was derived from a FreeRTOS performance statistics driver
written by Michal Simek.
The control interface provides a "create endpoint" ioctl, which is fed a
name, source and destination address. The three values are used to
create the endpoint, in a backend-specific way, and a rpmsg endpoint
device is created - with the three parameters are available in sysfs for
udev usage.
E.g. to create an endpoint device for one of the Qualcomm SMD channel
related to DIAG one would issue:
struct rpmsg_endpoint_info info = { "DIAG_CNTL", 0, 0 };
int fd = open("/dev/rpmsg_ctrl0", O_RDWR);
ioctl(fd, RPMSG_CREATE_EPT_IOCTL, &info);
Each created endpoint device shows up as an individual character device
in /dev, allowing permission to be controlled on a per-endpoint basis.
The rpmsg endpoint will be created and destroyed following the opening
and closing of the endpoint device, allowing rpmsg backends to open and
close the physical channel, if supported by the wire protocol.
Cc: Marek Novak <marek.novak@nxp.com>
Cc: Matteo Sartori <matteo.sartori@t3lab.it>
Cc: Michal Simek <monstr@monstr.eu>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2017-01-11 22:35:12 +08:00
|
|
|
{
|
2022-04-30 03:59:45 +08:00
|
|
|
return rpmsg_register_device_override(rpdev, "rpmsg_ctrl");
|
rpmsg: Driver for user space endpoint interface
This driver allows rpmsg instances to expose access to rpmsg endpoints
to user space processes. It provides a control interface, allowing
userspace to export endpoints and an endpoint interface for each exposed
endpoint.
The implementation is based on prior art by Texas Instrument, Google,
PetaLogix and was derived from a FreeRTOS performance statistics driver
written by Michal Simek.
The control interface provides a "create endpoint" ioctl, which is fed a
name, source and destination address. The three values are used to
create the endpoint, in a backend-specific way, and a rpmsg endpoint
device is created - with the three parameters are available in sysfs for
udev usage.
E.g. to create an endpoint device for one of the Qualcomm SMD channel
related to DIAG one would issue:
struct rpmsg_endpoint_info info = { "DIAG_CNTL", 0, 0 };
int fd = open("/dev/rpmsg_ctrl0", O_RDWR);
ioctl(fd, RPMSG_CREATE_EPT_IOCTL, &info);
Each created endpoint device shows up as an individual character device
in /dev, allowing permission to be controlled on a per-endpoint basis.
The rpmsg endpoint will be created and destroyed following the opening
and closing of the endpoint device, allowing rpmsg backends to open and
close the physical channel, if supported by the wire protocol.
Cc: Marek Novak <marek.novak@nxp.com>
Cc: Matteo Sartori <matteo.sartori@t3lab.it>
Cc: Michal Simek <monstr@monstr.eu>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2017-01-11 22:35:12 +08:00
|
|
|
}
|
|
|
|
|
|
2016-09-02 06:28:02 +08:00
|
|
|
#endif
|
