pipelink.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Trackunit Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#include <zephyr/modem/pipe.h>
#include <zephyr/devicetree.h>
#include <zephyr/sys/util.h>
 
#ifndef ZEPHYR_MODEM_PIPELINK_
#define ZEPHYR_MODEM_PIPELINK_
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum modem_pipelink_event {
        MODEM_PIPELINK_EVENT_CONNECTED = 0,
        MODEM_PIPELINK_EVENT_DISCONNECTED,
};
 
struct modem_pipelink;
 
typedef void (*modem_pipelink_callback)(struct modem_pipelink *link,
                                        enum modem_pipelink_event event,
                                        void *user_data);
 
struct modem_pipelink {
        struct modem_pipe *pipe;
        modem_pipelink_callback callback;
        void *user_data;
        bool connected;
        struct k_spinlock spinlock;
};
 
void modem_pipelink_attach(struct modem_pipelink *link,
                           modem_pipelink_callback callback,
                           void *user_data);
 
bool modem_pipelink_is_connected(struct modem_pipelink *link);
 
struct modem_pipe *modem_pipelink_get_pipe(struct modem_pipelink *link);
 
void modem_pipelink_release(struct modem_pipelink *link);
 
void modem_pipelink_init(struct modem_pipelink *link, struct modem_pipe *pipe);
 
void modem_pipelink_notify_connected(struct modem_pipelink *link);
 
void modem_pipelink_notify_disconnected(struct modem_pipelink *link);
 
#define MODEM_PIPELINK_DT_SYM(node_id, name) \
        _CONCAT_4(__modem_pipelink_, DT_DEP_ORD(node_id), _, name)
 
#define MODEM_PIPELINK_DT_DECLARE(node_id, name) \
        extern struct modem_pipelink MODEM_PIPELINK_DT_SYM(node_id, name)
 
#define MODEM_PIPELINK_DT_DEFINE(node_id, name) \
        struct modem_pipelink MODEM_PIPELINK_DT_SYM(node_id, name)
 
#define MODEM_PIPELINK_DT_GET(node_id, name) \
        (&MODEM_PIPELINK_DT_SYM(node_id, name))
 
#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)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_MODEM_PIPELINK_ */