Modem pipelink

Modem pipelink. More...

Macros
#define	MODEM_PIPELINK_DT_DECLARE(node_id, name)    extern struct modem_pipelink MODEM_PIPELINK_DT_SYM(node_id, name)
	Declare pipelink from devicetree node identifier and name.
#define	MODEM_PIPELINK_DT_DEFINE(node_id, name)    struct modem_pipelink MODEM_PIPELINK_DT_SYM(node_id, name)
	Define pipelink from devicetree node identifier and name.
#define	MODEM_PIPELINK_DT_GET(node_id, name)    (&MODEM_PIPELINK_DT_SYM(node_id, name))
	Get pointer to pipelink from devicetree node identifier and name.

Typedefs
typedef void(*	modem_pipelink_callback) (struct modem_pipelink *link, enum modem_pipelink_event event, void *user_data)
	Pipelink callback definition.

Enumerations
enum	modem_pipelink_event { MODEM_PIPELINK_EVENT_CONNECTED = 0 , MODEM_PIPELINK_EVENT_DISCONNECTED }
	Pipelink event. More...

Functions
void	modem_pipelink_attach (struct modem_pipelink *link, modem_pipelink_callback callback, void *user_data)
	Attach callback to pipelink.
bool	modem_pipelink_is_connected (struct modem_pipelink *link)
	Check whether pipelink pipe is connected.
struct modem_pipe *	modem_pipelink_get_pipe (struct modem_pipelink *link)
	Get pipe from pipelink.
void	modem_pipelink_release (struct modem_pipelink *link)
	Clear callback.

MODEM_PIPELINK_DT_INST macros
Device driver instance variants of MODEM_PIPELINK_DT macros
#define	MODEM_PIPELINK_DT_INST_DECLARE(inst, name)    MODEM_PIPELINK_DT_DECLARE(DT_DRV_INST(inst), name)
#define	MODEM_PIPELINK_DT_INST_DEFINE(inst, name)    MODEM_PIPELINK_DT_DEFINE(DT_DRV_INST(inst), name)
#define	MODEM_PIPELINK_DT_INST_GET(inst, name)    MODEM_PIPELINK_DT_GET(DT_DRV_INST(inst), name)

Detailed Description

Modem pipelink.

Macro Definition Documentation

MODEM_PIPELINK_DT_DECLARE

#define MODEM_PIPELINK_DT_DECLARE	(		node_id,
			name
	)		extern struct modem_pipelink MODEM_PIPELINK_DT_SYM(node_id, name)

#include <zephyr/modem/pipelink.h>

Declare pipelink from devicetree node identifier and name.

Parameters

node_id	Devicetree node identifier
name	Pipelink name

MODEM_PIPELINK_DT_DEFINE

#define MODEM_PIPELINK_DT_DEFINE	(		node_id,
			name
	)		struct modem_pipelink MODEM_PIPELINK_DT_SYM(node_id, name)

#include <zephyr/modem/pipelink.h>

Define pipelink from devicetree node identifier and name.

Parameters

node_id	Devicetree node identifier
name	Pipelink name

MODEM_PIPELINK_DT_GET

#define MODEM_PIPELINK_DT_GET	(		node_id,
			name
	)		(&MODEM_PIPELINK_DT_SYM(node_id, name))

#include <zephyr/modem/pipelink.h>

Get pointer to pipelink from devicetree node identifier and name.

Parameters

node_id	Devicetree node identifier
name	Pipelink name

MODEM_PIPELINK_DT_INST_DECLARE

#define MODEM_PIPELINK_DT_INST_DECLARE	(		inst,
			name
	)		MODEM_PIPELINK_DT_DECLARE(DT_DRV_INST(inst), name)

#include <zephyr/modem/pipelink.h>

MODEM_PIPELINK_DT_INST_DEFINE

#define MODEM_PIPELINK_DT_INST_DEFINE	(		inst,
			name
	)		MODEM_PIPELINK_DT_DEFINE(DT_DRV_INST(inst), name)

#include <zephyr/modem/pipelink.h>

MODEM_PIPELINK_DT_INST_GET

#define MODEM_PIPELINK_DT_INST_GET	(		inst,
			name
	)		MODEM_PIPELINK_DT_GET(DT_DRV_INST(inst), name)

#include <zephyr/modem/pipelink.h>

Typedef Documentation

modem_pipelink_callback

typedef void(* modem_pipelink_callback) (struct modem_pipelink *link, enum modem_pipelink_event event, void *user_data)

#include <zephyr/modem/pipelink.h>

Pipelink callback definition.

Parameters

link	Modem pipelink instance
event	Modem pipelink event
user_data	User data passed to modem_pipelink_attach()

Enumeration Type Documentation

modem_pipelink_event

enum modem_pipelink_event

#include <zephyr/modem/pipelink.h>

Pipelink event.

Enumerator
MODEM_PIPELINK_EVENT_CONNECTED	Modem pipe has been connected and can be opened.
MODEM_PIPELINK_EVENT_DISCONNECTED	Modem pipe has been disconnected and can't be opened.

Function Documentation

modem_pipelink_attach()

void modem_pipelink_attach	(	struct modem_pipelink *	link,
		modem_pipelink_callback	callback,
		void *	user_data
	)

#include <zephyr/modem/pipelink.h>

Attach callback to pipelink.

Parameters

link	Pipelink instance
callback	Pipelink callback
user_data	User data passed to pipelink callback

modem_pipelink_get_pipe()

struct modem_pipe * modem_pipelink_get_pipe

(

struct modem_pipelink *

link

)

#include <zephyr/modem/pipelink.h>

Get pipe from pipelink.

Parameters

link	Pipelink instance

Return values

Pointer	to pipe if pipelink has been initialized
NULL	if pipelink has not been initialized

modem_pipelink_is_connected()

bool modem_pipelink_is_connected

(

struct modem_pipelink *

link

)

#include <zephyr/modem/pipelink.h>

Check whether pipelink pipe is connected.

Parameters

link	Pipelink instance

Return values

true	if pipe is connected
false	if pipe is not connected

modem_pipelink_release()

void modem_pipelink_release

(

struct modem_pipelink *

link

)

#include <zephyr/modem/pipelink.h>

Clear callback.

Parameters

link	Pipelink instance