112 lines
3.3 KiB
C
112 lines
3.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0-only */
|
|
/* Copyright (c) 2021, Linaro Ltd <loic.poulain@linaro.org> */
|
|
|
|
#ifndef __WWAN_H
|
|
#define __WWAN_H
|
|
|
|
#include <linux/device.h>
|
|
#include <linux/kernel.h>
|
|
#include <linux/skbuff.h>
|
|
|
|
/**
|
|
* enum wwan_port_type - WWAN port types
|
|
* @WWAN_PORT_AT: AT commands
|
|
* @WWAN_PORT_MBIM: Mobile Broadband Interface Model control
|
|
* @WWAN_PORT_QMI: Qcom modem/MSM interface for modem control
|
|
* @WWAN_PORT_QCDM: Qcom Modem diagnostic interface
|
|
* @WWAN_PORT_FIREHOSE: XML based command protocol
|
|
* @WWAN_PORT_MAX: Number of supported port types
|
|
*/
|
|
enum wwan_port_type {
|
|
WWAN_PORT_AT,
|
|
WWAN_PORT_MBIM,
|
|
WWAN_PORT_QMI,
|
|
WWAN_PORT_QCDM,
|
|
WWAN_PORT_FIREHOSE,
|
|
WWAN_PORT_MAX,
|
|
};
|
|
|
|
struct wwan_port;
|
|
|
|
/** struct wwan_port_ops - The WWAN port operations
|
|
* @start: The routine for starting the WWAN port device.
|
|
* @stop: The routine for stopping the WWAN port device.
|
|
* @tx: The routine that sends WWAN port protocol data to the device.
|
|
*
|
|
* The wwan_port_ops structure contains a list of low-level operations
|
|
* that control a WWAN port device. All functions are mandatory.
|
|
*/
|
|
struct wwan_port_ops {
|
|
int (*start)(struct wwan_port *port);
|
|
void (*stop)(struct wwan_port *port);
|
|
int (*tx)(struct wwan_port *port, struct sk_buff *skb);
|
|
};
|
|
|
|
/**
|
|
* wwan_create_port - Add a new WWAN port
|
|
* @parent: Device to use as parent and shared by all WWAN ports
|
|
* @type: WWAN port type
|
|
* @ops: WWAN port operations
|
|
* @drvdata: Pointer to caller driver data
|
|
*
|
|
* Allocate and register a new WWAN port. The port will be automatically exposed
|
|
* to user as a character device and attached to the right virtual WWAN device,
|
|
* based on the parent pointer. The parent pointer is the device shared by all
|
|
* components of a same WWAN modem (e.g. USB dev, PCI dev, MHI controller...).
|
|
*
|
|
* drvdata will be placed in the WWAN port device driver data and can be
|
|
* retrieved with wwan_port_get_drvdata().
|
|
*
|
|
* This function must be balanced with a call to wwan_remove_port().
|
|
*
|
|
* Returns a valid pointer to wwan_port on success or PTR_ERR on failure
|
|
*/
|
|
struct wwan_port *wwan_create_port(struct device *parent,
|
|
enum wwan_port_type type,
|
|
const struct wwan_port_ops *ops,
|
|
void *drvdata);
|
|
|
|
/**
|
|
* wwan_remove_port - Remove a WWAN port
|
|
* @port: WWAN port to remove
|
|
*
|
|
* Remove a previously created port.
|
|
*/
|
|
void wwan_remove_port(struct wwan_port *port);
|
|
|
|
/**
|
|
* wwan_port_rx - Receive data from the WWAN port
|
|
* @port: WWAN port for which data is received
|
|
* @skb: Pointer to the rx buffer
|
|
*
|
|
* A port driver calls this function upon data reception (MBIM, AT...).
|
|
*/
|
|
void wwan_port_rx(struct wwan_port *port, struct sk_buff *skb);
|
|
|
|
/**
|
|
* wwan_port_txoff - Stop TX on WWAN port
|
|
* @port: WWAN port for which TX must be stopped
|
|
*
|
|
* Used for TX flow control, a port driver calls this function to indicate TX
|
|
* is temporary unavailable (e.g. due to ring buffer fullness).
|
|
*/
|
|
void wwan_port_txoff(struct wwan_port *port);
|
|
|
|
|
|
/**
|
|
* wwan_port_txon - Restart TX on WWAN port
|
|
* @port: WWAN port for which TX must be restarted
|
|
*
|
|
* Used for TX flow control, a port driver calls this function to indicate TX
|
|
* is available again.
|
|
*/
|
|
void wwan_port_txon(struct wwan_port *port);
|
|
|
|
/**
|
|
* wwan_port_get_drvdata - Retrieve driver data from a WWAN port
|
|
* @port: Related WWAN port
|
|
*/
|
|
void *wwan_port_get_drvdata(struct wwan_port *port);
|
|
|
|
#endif /* __WWAN_H */
|