summaryrefslogtreecommitdiff
path: root/openpicc/os/core/include/serial.h
blob: 58c7a5ffd737dfd5f8e7186a0fd49522c72d1920 (plain)
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
	FreeRTOS.org V4.2.1 - Copyright (C) 2003-2007 Richard Barry.

	This file is part of the FreeRTOS.org distribution.

	FreeRTOS.org 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.

	FreeRTOS.org 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 FreeRTOS.org; if not, write to the Free Software
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

	A special exception to the GPL can be applied should you wish to distribute
	a combined work that includes FreeRTOS.org, without being obliged to provide
	the source code for any proprietary components.  See the licensing section 
	of http://www.FreeRTOS.org for full details of how and when the exception
	can be applied.

	***************************************************************************
	See http://www.FreeRTOS.org for documentation, latest information, license 
	and contact details.  Please ensure to read the configuration and relevant 
	port sections of the online documentation.

	Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along
	with commercial development and support options.
	***************************************************************************
*/

#ifndef SERIAL_COMMS_H
#define SERIAL_COMMS_H

typedef void *xComPortHandle;

typedef enum
{
  serCOM1,
  serCOM2,
  serCOM3,
  serCOM4,
  serCOM5,
  serCOM6,
  serCOM7,
  serCOM8
} eCOMPort;

typedef enum
{
  serNO_PARITY,
  serODD_PARITY,
  serEVEN_PARITY,
  serMARK_PARITY,
  serSPACE_PARITY
} eParity;

typedef enum
{
  serSTOP_1,
  serSTOP_2
} eStopBits;

typedef enum
{
  serBITS_5,
  serBITS_6,
  serBITS_7,
  serBITS_8
} eDataBits;

typedef enum
{
  ser50,
  ser75,
  ser110,
  ser134,
  ser150,
  ser200,
  ser300,
  ser600,
  ser1200,
  ser1800,
  ser2400,
  ser4800,
  ser9600,
  ser19200,
  ser38400,
  ser57600,
  ser115200
} eBaud;

xComPortHandle xSerialPortInitMinimal (unsigned portLONG ulWantedBaud,
				       unsigned portBASE_TYPE uxQueueLength);
xComPortHandle xSerialPortInit (eCOMPort ePort, eBaud eWantedBaud,
				eParity eWantedParity,
				eDataBits eWantedDataBits,
				eStopBits eWantedStopBits,
				unsigned portBASE_TYPE uxBufferLength);
void vSerialPutString (xComPortHandle pxPort,
		       const signed portCHAR * const pcString,
		       unsigned portSHORT usStringLength);
signed portBASE_TYPE xSerialGetChar (xComPortHandle pxPort,
				     signed portCHAR * pcRxedChar,
				     portTickType xBlockTime);
signed portBASE_TYPE xSerialPutChar (xComPortHandle pxPort,
				     signed portCHAR cOutChar,
				     portTickType xBlockTime);
portBASE_TYPE xSerialWaitForSemaphore (xComPortHandle xPort);
void vSerialClose (xComPortHandle xPort);

#endif
personal git repositories of Harald Welte. Your mileage may vary