Zephyr API Documentation 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
pipe.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Trackunit Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#include <zephyr/types.h>
8#include <zephyr/kernel.h>
9
10#ifndef ZEPHYR_MODEM_PIPE_
11#define ZEPHYR_MODEM_PIPE_
12
13#ifdef __cplusplus
14extern "C" {
15#endif
16
25
33
37
38struct modem_pipe;
39
43
44typedef void (*modem_pipe_api_callback)(struct modem_pipe *pipe, enum modem_pipe_event event,
45 void *user_data);
46
50
51typedef int (*modem_pipe_api_open)(void *data);
52
53typedef int (*modem_pipe_api_transmit)(void *data, const uint8_t *buf, size_t size);
54
55typedef int (*modem_pipe_api_receive)(void *data, uint8_t *buf, size_t size);
56
57typedef int (*modem_pipe_api_close)(void *data);
58
59struct modem_pipe_api {
60 modem_pipe_api_open open;
61 modem_pipe_api_transmit transmit;
62 modem_pipe_api_receive receive;
63 modem_pipe_api_close close;
64};
65
66struct modem_pipe {
67 void *data;
68 const struct modem_pipe_api *api;
70 void *user_data;
71 struct k_spinlock spinlock;
72 struct k_event event;
73};
74
82void modem_pipe_init(struct modem_pipe *pipe, void *data, const struct modem_pipe_api *api);
83
87
101int modem_pipe_open(struct modem_pipe *pipe, k_timeout_t timeout);
102
114int modem_pipe_open_async(struct modem_pipe *pipe);
115
126void modem_pipe_attach(struct modem_pipe *pipe, modem_pipe_api_callback callback, void *user_data);
127
141int modem_pipe_transmit(struct modem_pipe *pipe, const uint8_t *buf, size_t size);
142
156int modem_pipe_receive(struct modem_pipe *pipe, uint8_t *buf, size_t size);
157
163void modem_pipe_release(struct modem_pipe *pipe);
164
178int modem_pipe_close(struct modem_pipe *pipe, k_timeout_t timeout);
179
191int modem_pipe_close_async(struct modem_pipe *pipe);
192
196
204void modem_pipe_notify_opened(struct modem_pipe *pipe);
205
213void modem_pipe_notify_closed(struct modem_pipe *pipe);
214
222void modem_pipe_notify_receive_ready(struct modem_pipe *pipe);
223
231void modem_pipe_notify_transmit_idle(struct modem_pipe *pipe);
232
236
240
241#ifdef __cplusplus
242}
243#endif
244
245#endif /* ZEPHYR_MODEM_PIPE_ */
int open(const char *name, int flags,...)
int modem_pipe_open_async(struct modem_pipe *pipe)
Open pipe asynchronously.
int modem_pipe_close(struct modem_pipe *pipe, k_timeout_t timeout)
Close pipe.
void modem_pipe_attach(struct modem_pipe *pipe, modem_pipe_api_callback callback, void *user_data)
Attach pipe to callback.
int modem_pipe_transmit(struct modem_pipe *pipe, const uint8_t *buf, size_t size)
Transmit data through pipe.
int modem_pipe_open(struct modem_pipe *pipe, k_timeout_t timeout)
Open pipe.
int modem_pipe_close_async(struct modem_pipe *pipe)
Close pipe asynchronously.
int modem_pipe_receive(struct modem_pipe *pipe, uint8_t *buf, size_t size)
Receive data through pipe.
modem_pipe_event
Modem pipe event.
Definition pipe.h:27
void modem_pipe_release(struct modem_pipe *pipe)
Clear callback.
void(* modem_pipe_api_callback)(struct modem_pipe *pipe, enum modem_pipe_event event, void *user_data)
Definition pipe.h:44
@ MODEM_PIPE_EVENT_RECEIVE_READY
Definition pipe.h:29
@ MODEM_PIPE_EVENT_OPENED
Definition pipe.h:28
@ MODEM_PIPE_EVENT_TRANSMIT_IDLE
Definition pipe.h:30
@ MODEM_PIPE_EVENT_CLOSED
Definition pipe.h:31
Public kernel APIs.
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Kernel timeout type.
Definition clock.h:65