-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathec_serial.h
More file actions
85 lines (62 loc) · 3.71 KB
/
ec_serial.h
File metadata and controls
85 lines (62 loc) · 3.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
Copyright (C) 2020 Embed Creativity LLC
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/************************************************************************/
/* */
/* ec_serial.h -- EmbedCreativity's Serial Comm header file */
/* */
/************************************************************************/
/* Author: Mark Taylor */
/************************************************************************/
/* File Description: */
/* */
/* This header file contains declarations the functions contained in */
/* ec_serial.c */
/* */
/************************************************************************/
/* Revision History: */
/* */
/* 02/02/2009(MarkT): created */
/* 02/24/2017(MarkT): added support for timeout in SerialRead() */
/* */
/************************************************************************/
#if !defined(_SERIALCONTROL_H)
#define _SERIALCONTOL_H
#include <stdint.h> /* for unsigned values*/
/* ------------------------------------------------------------ */
/* Definitions */
/* ------------------------------------------------------------ */
#define SERIAL_ERROR_CODE -1
#define SERIAL_TIMEOUT_CODE -2
/* ------------------------------------------------------------ */
/* General Type Declarations */
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/* Object Class Declarations */
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/* Variable Declarations */
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/* Function Prototypes */
/* ------------------------------------------------------------ */
bool SerialWriteNBytes(uint8_t *rgbChars, int n);
bool SerialWriteByte(uint8_t *pByte);
int SerialRead(uint8_t *result, uint32_t len, uint32_t timeOutMs);
int SerialGetBaud(void);
bool SerialInit(char *szDevice, int baudRate);
void SerialClose(void);
/* ------------------------------------------------------------ */
#endif
/********************************** EOF **************************************/