PixelKey
NeoPixel USB Key
Loading...
Searching...
No Matches
serial.h
Go to the documentation of this file.
1#ifndef SERIAL_H
2#define SERIAL_H
3
11#include <stdlib.h>
12#include <stdint.h>
13#include <stdbool.h>
14
15#include "pixelkey_errors.h"
16
18typedef struct st_serial
19{
28 pixelkey_error_t (* read)(uint8_t * p_buffer, size_t * p_read_length);
29
38 pixelkey_error_t (* write)(uint8_t * p_buffer, size_t write_length);
39
45 pixelkey_error_t (* flush)(void);
46
51 bool (* rts_get)(void);
53
54serial_api_t const * serial(void);
55void serial_register(serial_api_t const * p_instance);
56
59#endif
void serial_register(serial_api_t const *p_instance)
Register a serial instance to be used.
Definition: serial.c:24
serial_api_t const * serial(void)
Gets the currently registered serial instance.
Definition: serial.c:15
pixelkey_error_t
PixelKey errors.
Definition: pixelkey_errors.h:11
Serial communications interface abstraction.
Definition: serial.h:19