linux/drivers/net/wwan/rpmsg_wwan_ctrl.c
Stephan Gerhold 31c143f712 net: wwan: Allow WWAN drivers to provide blocking tx and poll function
At the moment, the WWAN core provides wwan_port_txon/off() to implement
blocking writes. The tx() port operation should not block, instead
wwan_port_txon/off() should be called when the TX queue is full or has
free space again.

However, in some cases it is not straightforward to make use of that
functionality. For example, the RPMSG API used by rpmsg_wwan_ctrl.c
does not provide any way to be notified when the TX queue has space
again. Instead, it only provides the following operations:

  - rpmsg_send(): blocking write (wait until there is space)
  - rpmsg_trysend(): non-blocking write (return error if no space)
  - rpmsg_poll(): set poll flags depending on TX queue state

Generally that's totally sufficient for implementing a char device,
but it does not fit well to the currently provided WWAN port ops.

Most of the time, using the non-blocking rpmsg_trysend() in the
WWAN tx() port operation works just fine. However, with high-frequent
writes to the char device it is possible to trigger a situation
where this causes issues. For example, consider the following
(somewhat unrealistic) example:

 # dd if=/dev/zero bs=1000 of=/dev/wwan0qmi0
 dd: error writing '/dev/wwan0qmi0': Resource temporarily unavailable
 1+0 records out

This fails immediately after writing the first record. It's likely
only a matter of time until this triggers issues for some real application
(e.g. ModemManager sending a lot of large QMI packets).

The rpmsg_char device does not have this problem, because it uses
rpmsg_trysend() and rpmsg_poll() to support non-blocking operations.
Make it possible to use the same in the RPMSG WWAN driver by adding
two new optional wwan_port_ops:

  - tx_blocking(): send data blocking if allowed
  - tx_poll(): set additional TX poll flags

This integrates nicely with the RPMSG API and does not require
any change in existing WWAN drivers.

With these changes, the dd example above blocks instead of exiting
with an error.

Cc: Loic Poulain <loic.poulain@linaro.org>
Signed-off-by: Stephan Gerhold <stephan@gerhold.net>
Signed-off-by: David S. Miller <davem@davemloft.net>
2021-06-18 13:13:40 -07:00

167 lines
4.2 KiB
C

// SPDX-License-Identifier: GPL-2.0-only
/* Copyright (c) 2021, Stephan Gerhold <stephan@gerhold.net> */
#include <linux/kernel.h>
#include <linux/mod_devicetable.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/rpmsg.h>
#include <linux/wwan.h>
struct rpmsg_wwan_dev {
/* Lower level is a rpmsg dev, upper level is a wwan port */
struct rpmsg_device *rpdev;
struct wwan_port *wwan_port;
struct rpmsg_endpoint *ept;
};
static int rpmsg_wwan_ctrl_callback(struct rpmsg_device *rpdev,
void *buf, int len, void *priv, u32 src)
{
struct rpmsg_wwan_dev *rpwwan = priv;
struct sk_buff *skb;
skb = alloc_skb(len, GFP_ATOMIC);
if (!skb)
return -ENOMEM;
skb_put_data(skb, buf, len);
wwan_port_rx(rpwwan->wwan_port, skb);
return 0;
}
static int rpmsg_wwan_ctrl_start(struct wwan_port *port)
{
struct rpmsg_wwan_dev *rpwwan = wwan_port_get_drvdata(port);
struct rpmsg_channel_info chinfo = {
.src = rpwwan->rpdev->src,
.dst = RPMSG_ADDR_ANY,
};
strncpy(chinfo.name, rpwwan->rpdev->id.name, RPMSG_NAME_SIZE);
rpwwan->ept = rpmsg_create_ept(rpwwan->rpdev, rpmsg_wwan_ctrl_callback,
rpwwan, chinfo);
if (!rpwwan->ept)
return -EREMOTEIO;
return 0;
}
static void rpmsg_wwan_ctrl_stop(struct wwan_port *port)
{
struct rpmsg_wwan_dev *rpwwan = wwan_port_get_drvdata(port);
rpmsg_destroy_ept(rpwwan->ept);
rpwwan->ept = NULL;
}
static int rpmsg_wwan_ctrl_tx(struct wwan_port *port, struct sk_buff *skb)
{
struct rpmsg_wwan_dev *rpwwan = wwan_port_get_drvdata(port);
int ret;
ret = rpmsg_trysend(rpwwan->ept, skb->data, skb->len);
if (ret)
return ret;
consume_skb(skb);
return 0;
}
static int rpmsg_wwan_ctrl_tx_blocking(struct wwan_port *port, struct sk_buff *skb)
{
struct rpmsg_wwan_dev *rpwwan = wwan_port_get_drvdata(port);
int ret;
ret = rpmsg_send(rpwwan->ept, skb->data, skb->len);
if (ret)
return ret;
consume_skb(skb);
return 0;
}
static __poll_t rpmsg_wwan_ctrl_tx_poll(struct wwan_port *port,
struct file *filp, poll_table *wait)
{
struct rpmsg_wwan_dev *rpwwan = wwan_port_get_drvdata(port);
return rpmsg_poll(rpwwan->ept, filp, wait);
}
static const struct wwan_port_ops rpmsg_wwan_pops = {
.start = rpmsg_wwan_ctrl_start,
.stop = rpmsg_wwan_ctrl_stop,
.tx = rpmsg_wwan_ctrl_tx,
.tx_blocking = rpmsg_wwan_ctrl_tx_blocking,
.tx_poll = rpmsg_wwan_ctrl_tx_poll,
};
static struct device *rpmsg_wwan_find_parent(struct device *dev)
{
/* Select first platform device as parent for the WWAN ports.
* On Qualcomm platforms this is usually the platform device that
* represents the modem remote processor. This might need to be
* adjusted when adding device IDs for other platforms.
*/
for (dev = dev->parent; dev; dev = dev->parent) {
if (dev_is_platform(dev))
return dev;
}
return NULL;
}
static int rpmsg_wwan_ctrl_probe(struct rpmsg_device *rpdev)
{
struct rpmsg_wwan_dev *rpwwan;
struct wwan_port *port;
struct device *parent;
parent = rpmsg_wwan_find_parent(&rpdev->dev);
if (!parent)
return -ENODEV;
rpwwan = devm_kzalloc(&rpdev->dev, sizeof(*rpwwan), GFP_KERNEL);
if (!rpwwan)
return -ENOMEM;
rpwwan->rpdev = rpdev;
dev_set_drvdata(&rpdev->dev, rpwwan);
/* Register as a wwan port, id.driver_data contains wwan port type */
port = wwan_create_port(parent, rpdev->id.driver_data,
&rpmsg_wwan_pops, rpwwan);
if (IS_ERR(port))
return PTR_ERR(port);
rpwwan->wwan_port = port;
return 0;
};
static void rpmsg_wwan_ctrl_remove(struct rpmsg_device *rpdev)
{
struct rpmsg_wwan_dev *rpwwan = dev_get_drvdata(&rpdev->dev);
wwan_remove_port(rpwwan->wwan_port);
}
static const struct rpmsg_device_id rpmsg_wwan_ctrl_id_table[] = {
/* RPMSG channels for Qualcomm SoCs with integrated modem */
{ .name = "DATA5_CNTL", .driver_data = WWAN_PORT_QMI },
{ .name = "DATA4", .driver_data = WWAN_PORT_AT },
{},
};
MODULE_DEVICE_TABLE(rpmsg, rpmsg_wwan_ctrl_id_table);
static struct rpmsg_driver rpmsg_wwan_ctrl_driver = {
.drv.name = "rpmsg_wwan_ctrl",
.id_table = rpmsg_wwan_ctrl_id_table,
.probe = rpmsg_wwan_ctrl_probe,
.remove = rpmsg_wwan_ctrl_remove,
};
module_rpmsg_driver(rpmsg_wwan_ctrl_driver);
MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("RPMSG WWAN CTRL Driver");
MODULE_AUTHOR("Stephan Gerhold <stephan@gerhold.net>");