Skip to content

Commit

Permalink
rpmsg: Clean up rpmsg device vs channel naming
Browse files Browse the repository at this point in the history 
The rpmsg device representing struct is called rpmsg_channel and the
variable name used throughout is rpdev, with the communication happening
on endpoints it's clearer to just call this a "device" in a public API.

Signed-off-by: Bjorn Andersson <[email protected]>
  • Loading branch information
@andersson
andersson committed Sep 9, 2016
1 parent 2b263d2 commit 92e1de5
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 39 deletions.
42 changes: 21 additions & 21 deletions drivers/rpmsg/virtio_rpmsg_bus.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ struct virtproc_info {
struct rpmsg_endpoint *ns_ept;
};

#define to_rpmsg_channel(d) container_of(d, struct rpmsg_channel, dev)
#define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
#define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)

/*
Expand Down Expand Up @@ -113,7 +113,7 @@ static ssize_t \
field##_show(struct device *dev, \
struct device_attribute *attr, char *buf) \
{ \
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev); \
struct rpmsg_device *rpdev = to_rpmsg_device(dev); \
\
return sprintf(buf, format_string, rpdev->path); \
}
Expand All @@ -127,7 +127,7 @@ rpmsg_show_attr(announce, announce ? "true" : "false", "%s\n");
static ssize_t modalias_show(struct device *dev,
struct device_attribute *attr, char *buf)
{
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);

return sprintf(buf, RPMSG_DEVICE_MODALIAS_FMT "\n", rpdev->id.name);
}
Expand All @@ -142,7 +142,7 @@ static struct device_attribute rpmsg_dev_attrs[] = {
};

/* rpmsg devices and drivers are matched using the service name */
static inline int rpmsg_id_match(const struct rpmsg_channel *rpdev,
static inline int rpmsg_id_match(const struct rpmsg_device *rpdev,
const struct rpmsg_device_id *id)
{
return strncmp(id->name, rpdev->id.name, RPMSG_NAME_SIZE) == 0;
Expand All @@ -151,7 +151,7 @@ static inline int rpmsg_id_match(const struct rpmsg_channel *rpdev,
/* match rpmsg channel and rpmsg driver */
static int rpmsg_dev_match(struct device *dev, struct device_driver *drv)
{
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);
struct rpmsg_driver *rpdrv = to_rpmsg_driver(drv);
const struct rpmsg_device_id *ids = rpdrv->id_table;
unsigned int i;
Expand All @@ -166,7 +166,7 @@ static int rpmsg_dev_match(struct device *dev, struct device_driver *drv)

static int rpmsg_uevent(struct device *dev, struct kobj_uevent_env *env)
{
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);

return add_uevent_var(env, "MODALIAS=" RPMSG_DEVICE_MODALIAS_FMT,
rpdev->id.name);
Expand Down Expand Up @@ -194,7 +194,7 @@ static void __ept_release(struct kref *kref)

/* for more info, see below documentation of rpmsg_create_ept() */
static struct rpmsg_endpoint *__rpmsg_create_ept(struct virtproc_info *vrp,
struct rpmsg_channel *rpdev,
struct rpmsg_device *rpdev,
rpmsg_rx_cb_t cb,
void *priv, u32 addr)
{
Expand Down Expand Up @@ -282,7 +282,7 @@ static struct rpmsg_endpoint *__rpmsg_create_ept(struct virtproc_info *vrp,
*
* Returns a pointer to the endpoint on success, or NULL on error.
*/
struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *rpdev,
struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_device *rpdev,
rpmsg_rx_cb_t cb, void *priv,
struct rpmsg_channel_info chinfo)
{
Expand Down Expand Up @@ -339,7 +339,7 @@ EXPORT_SYMBOL(rpmsg_destroy_ept);
*/
static int rpmsg_dev_probe(struct device *dev)
{
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);
struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);
struct virtproc_info *vrp = rpdev->vrp;
struct rpmsg_channel_info chinfo = {};
Expand Down Expand Up @@ -387,7 +387,7 @@ static int rpmsg_dev_probe(struct device *dev)

static int rpmsg_dev_remove(struct device *dev)
{
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);
struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);
struct virtproc_info *vrp = rpdev->vrp;
int err = 0;
Expand Down Expand Up @@ -451,7 +451,7 @@ EXPORT_SYMBOL(unregister_rpmsg_driver);

static void rpmsg_release_device(struct device *dev)
{
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);

kfree(rpdev);
}
Expand All @@ -461,10 +461,10 @@ static void rpmsg_release_device(struct device *dev)
* this is used to make sure we're not creating rpmsg devices for channels
* that already exist.
*/
static int rpmsg_channel_match(struct device *dev, void *data)
static int rpmsg_device_match(struct device *dev, void *data)
{
struct rpmsg_channel_info *chinfo = data;
struct rpmsg_channel *rpdev = to_rpmsg_channel(dev);
struct rpmsg_device *rpdev = to_rpmsg_device(dev);

if (chinfo->src != RPMSG_ADDR_ANY && chinfo->src != rpdev->src)
return 0;
Expand All @@ -484,15 +484,15 @@ static int rpmsg_channel_match(struct device *dev, void *data)
* this function will be used to create both static and dynamic
* channels.
*/
static struct rpmsg_channel *rpmsg_create_channel(struct virtproc_info *vrp,
struct rpmsg_channel_info *chinfo)
static struct rpmsg_device *rpmsg_create_channel(struct virtproc_info *vrp,
struct rpmsg_channel_info *chinfo)
{
struct rpmsg_channel *rpdev;
struct rpmsg_device *rpdev;
struct device *tmp, *dev = &vrp->vdev->dev;
int ret;

/* make sure a similar channel doesn't already exist */
tmp = device_find_child(dev, chinfo, rpmsg_channel_match);
tmp = device_find_child(dev, chinfo, rpmsg_device_match);
if (tmp) {
/* decrement the matched device's refcount back */
put_device(tmp);
Expand Down Expand Up @@ -544,7 +544,7 @@ static int rpmsg_destroy_channel(struct virtproc_info *vrp,
struct virtio_device *vdev = vrp->vdev;
struct device *dev;

dev = device_find_child(&vdev->dev, chinfo, rpmsg_channel_match);
dev = device_find_child(&vdev->dev, chinfo, rpmsg_device_match);
if (!dev)
return -EINVAL;

Expand Down Expand Up @@ -669,7 +669,7 @@ static void rpmsg_downref_sleepers(struct virtproc_info *vrp)
*
* Returns 0 on success and an appropriate error value on failure.
*/
int rpmsg_send_offchannel_raw(struct rpmsg_channel *rpdev, u32 src, u32 dst,
int rpmsg_send_offchannel_raw(struct rpmsg_device *rpdev, u32 src, u32 dst,
void *data, int len, bool wait)
{
struct virtproc_info *vrp = rpdev->vrp;
Expand Down Expand Up @@ -879,11 +879,11 @@ static void rpmsg_xmit_done(struct virtqueue *svq)
}

/* invoked when a name service announcement arrives */
static void rpmsg_ns_cb(struct rpmsg_channel *rpdev, void *data, int len,
static void rpmsg_ns_cb(struct rpmsg_device *rpdev, void *data, int len,
void *priv, u32 src)
{
struct rpmsg_ns_msg *msg = data;
struct rpmsg_channel *newch;
struct rpmsg_device *newch;
struct rpmsg_channel_info chinfo;
struct virtproc_info *vrp = priv;
struct device *dev = &vrp->vdev->dev;
Expand Down
32 changes: 17 additions & 15 deletions include/linux/rpmsg.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ struct rpmsg_channel_info {
};

/**
* rpmsg_channel - devices that belong to the rpmsg bus are called channels
* rpmsg_device - device that belong to the rpmsg bus
* @vrp: the remote processor this channel belongs to
* @dev: the device struct
* @id: device id (used to match between rpmsg drivers and devices)
Expand All @@ -119,7 +119,7 @@ struct rpmsg_channel_info {
* @ept: the rpmsg endpoint of this channel
* @announce: if set, rpmsg will announce the creation/removal of this channel
*/
struct rpmsg_channel {
struct rpmsg_device {
struct virtproc_info *vrp;
struct device dev;
struct rpmsg_device_id id;
Expand All @@ -129,7 +129,7 @@ struct rpmsg_channel {
bool announce;
};

typedef void (*rpmsg_rx_cb_t)(struct rpmsg_channel *, void *, int, void *, u32);
typedef void (*rpmsg_rx_cb_t)(struct rpmsg_device *, void *, int, void *, u32);

/**
* struct rpmsg_endpoint - binds a local rpmsg address to its user
Expand All @@ -155,7 +155,7 @@ typedef void (*rpmsg_rx_cb_t)(struct rpmsg_channel *, void *, int, void *, u32);
* create additional endpoints by themselves (see rpmsg_create_ept()).
*/
struct rpmsg_endpoint {
struct rpmsg_channel *rpdev;
struct rpmsg_device *rpdev;
struct kref refcount;
rpmsg_rx_cb_t cb;
struct mutex cb_lock;
Expand All @@ -174,19 +174,21 @@ struct rpmsg_endpoint {
struct rpmsg_driver {
struct device_driver drv;
const struct rpmsg_device_id *id_table;
int (*probe)(struct rpmsg_channel *dev);
void (*remove)(struct rpmsg_channel *dev);
void (*callback)(struct rpmsg_channel *, void *, int, void *, u32);
int (*probe)(struct rpmsg_device *dev);
void (*remove)(struct rpmsg_device *dev);
void (*callback)(struct rpmsg_device *, void *, int, void *, u32);
};

int register_rpmsg_device(struct rpmsg_device *dev);
void unregister_rpmsg_device(struct rpmsg_device *dev);
int __register_rpmsg_driver(struct rpmsg_driver *drv, struct module *owner);
void unregister_rpmsg_driver(struct rpmsg_driver *drv);
void rpmsg_destroy_ept(struct rpmsg_endpoint *);
struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_device *,
rpmsg_rx_cb_t cb, void *priv,
struct rpmsg_channel_info chinfo);
int
rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
rpmsg_send_offchannel_raw(struct rpmsg_device *, u32, u32, void *, int, bool);

/* use a macro to avoid include chaining to get THIS_MODULE */
#define register_rpmsg_driver(drv) \
Expand Down Expand Up @@ -224,7 +226,7 @@ rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
*/
static inline int rpmsg_send(struct rpmsg_endpoint *ept, void *data, int len)
{
struct rpmsg_channel *rpdev = ept->rpdev;
struct rpmsg_device *rpdev = ept->rpdev;
u32 src = ept->addr, dst = rpdev->dst;

return rpmsg_send_offchannel_raw(rpdev, src, dst, data, len, true);
Expand All @@ -251,7 +253,7 @@ static inline int rpmsg_send(struct rpmsg_endpoint *ept, void *data, int len)
static inline
int rpmsg_sendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst)
{
struct rpmsg_channel *rpdev = ept->rpdev;
struct rpmsg_device *rpdev = ept->rpdev;
u32 src = ept->addr;

return rpmsg_send_offchannel_raw(rpdev, src, dst, data, len, true);
Expand Down Expand Up @@ -281,7 +283,7 @@ static inline
int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
void *data, int len)
{
struct rpmsg_channel *rpdev = ept->rpdev;
struct rpmsg_device *rpdev = ept->rpdev;

return rpmsg_send_offchannel_raw(rpdev, src, dst, data, len, true);
}
Expand All @@ -306,7 +308,7 @@ int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
static inline
int rpmsg_trysend(struct rpmsg_endpoint *ept, void *data, int len)
{
struct rpmsg_channel *rpdev = ept->rpdev;
struct rpmsg_device *rpdev = ept->rpdev;
u32 src = ept->addr, dst = rpdev->dst;

return rpmsg_send_offchannel_raw(rpdev, src, dst, data, len, false);
Expand All @@ -332,7 +334,7 @@ int rpmsg_trysend(struct rpmsg_endpoint *ept, void *data, int len)
static inline
int rpmsg_trysendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst)
{
struct rpmsg_channel *rpdev = ept->rpdev;
struct rpmsg_device *rpdev = ept->rpdev;
u32 src = ept->addr;

return rpmsg_send_offchannel_raw(rpdev, src, dst, data, len, false);
Expand Down Expand Up @@ -361,7 +363,7 @@ static inline
int rpmsg_trysend_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
void *data, int len)
{
struct rpmsg_channel *rpdev = ept->rpdev;
struct rpmsg_device *rpdev = ept->rpdev;

return rpmsg_send_offchannel_raw(rpdev, src, dst, data, len, false);
}
Expand Down
6 changes: 3 additions & 3 deletions samples/rpmsg/rpmsg_client_sample.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ struct instance_data {
int rx_count;
};

static void rpmsg_sample_cb(struct rpmsg_channel *rpdev, void *data, int len,
static void rpmsg_sample_cb(struct rpmsg_device *rpdev, void *data, int len,
void *priv, u32 src)
{
int ret;
Expand All @@ -52,7 +52,7 @@ static void rpmsg_sample_cb(struct rpmsg_channel *rpdev, void *data, int len,
dev_err(&rpdev->dev, "rpmsg_send failed: %d\n", ret);
}

static int rpmsg_sample_probe(struct rpmsg_channel *rpdev)
static int rpmsg_sample_probe(struct rpmsg_device *rpdev)
{
int ret;
struct instance_data *idata;
Expand All @@ -76,7 +76,7 @@ static int rpmsg_sample_probe(struct rpmsg_channel *rpdev)
return 0;
}

static void rpmsg_sample_remove(struct rpmsg_channel *rpdev)
static void rpmsg_sample_remove(struct rpmsg_device *rpdev)
{
dev_info(&rpdev->dev, "rpmsg sample client driver is removed\n");
}
Expand Down

0 comments on commit 92e1de5

Please sign in to comment.