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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
------------------------------------------------------------------------------
-- --
-- GNAT COMPILER COMPONENTS --
-- --
-- G N A T . S E R I A L _ C O M M U N I C A T I O N S --
-- --
-- S p e c --
-- --
-- Copyright (C) 2007-2023, AdaCore --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception, --
-- version 3.1, as published by the Free Software Foundation. --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
-- Serial communications package, implemented on Windows and GNU/Linux
with Ada.Streams;
with Interfaces.C;
with System.OS_Constants;
package GNAT.Serial_Communications is
-- Following is a simple example of using GNAT.Serial_Communications.
--
-- with Ada.Streams;
-- with GNAT.Serial_Communications;
--
-- procedure Serial is
-- use Ada.Streams;
-- use GNAT;
--
-- subtype Message is Stream_Element_Array (1 .. 20);
--
-- Data : constant String (1 .. 20) := "ABCDEFGHIJLKMNOPQRST";
-- Buffer : Message;
--
-- S_Port : constant Natural := 5;
-- -- Serial port number
--
-- begin
-- -- Convert message (String -> Stream_Element_Array)
--
-- for K in Data'Range loop
-- Buffer (Stream_Element_Offset (K)) := Character'Pos (Data (K));
-- end loop;
--
-- declare
-- Port_Name : constant Serial_Communications.Port_Name :=
-- Serial_Communications.Name (Number => S_Port);
-- Port : Serial_Communications.Serial_Port;
--
-- begin
-- Serial_Communications.Open
-- (Port => Port,
-- Name => Port_Name);
--
-- Serial_Communications.Set
-- (Port => Port,
-- Rate => Serial_Communications.B9600,
-- Bits => Serial_Communications.CS8,
-- Stop_Bits => Serial_Communications.One,
-- Parity => Serial_Communications.Even);
--
-- Serial_Communications.Write
-- (Port => Port,
-- Buffer => Buffer);
--
-- Serial_Communications.Close
-- (Port => Port);
-- end;
-- end Serial;
Serial_Error : exception;
-- Raised when a communication problem occurs
type Port_Name is new String;
-- A serial com port name
function Name (Number : Positive) return Port_Name;
-- Returns a possible port name for the given legacy PC architecture serial
-- port number (COM<number>: on Windows, ttyS<number-1> on Linux).
-- Note that this function does not support other kinds of serial ports
-- nor operating systems other than Windows and Linux. For all other
-- cases, an explicit port name can be passed directly to Open.
type Data_Rate is
(B75, B110, B150, B300, B600, B1200,
B2400, B4800, B9600,
B19200, B38400, B57600, B115200,
B230400, B460800, B500000, B576000, B921600,
B1000000, B1152000, B1500000,
B2000000, B2500000, B3000000,
B3500000, B4000000);
-- Speed of the communication
type Data_Bits is (CS8, CS7);
-- Communication bits
type Stop_Bits_Number is (One, Two);
-- One or two stop bits
type Parity_Check is (None, Even, Odd);
-- Either no parity check or an even or odd parity
type Flow_Control is (None, RTS_CTS, Xon_Xoff);
-- No flow control, hardware flow control, software flow control
type Serial_Port is new Ada.Streams.Root_Stream_Type with private;
-- Serial port stream type
type Serial_Port_Descriptor is
new System.OS_Constants.Serial_Port_Descriptor;
-- OS specific serial port descriptor
procedure Open
(Port : out Serial_Port;
Name : Port_Name);
-- Open the given port name. Raises Serial_Error if the port cannot be
-- opened.
procedure Set
(Port : Serial_Port;
Rate : Data_Rate := B9600;
Bits : Data_Bits := CS8;
Stop_Bits : Stop_Bits_Number := One;
Parity : Parity_Check := None;
Block : Boolean := True;
Local : Boolean := True;
Flow : Flow_Control := None;
Timeout : Duration := 10.0);
-- The communication port settings. If Block is set then a read call
-- will wait for the whole buffer to be filed. If Block is not set then
-- the given Timeout (in seconds) is used. If Local is set then modem
-- control lines (in particular DCD) are ignored (not supported on
-- Windows). Flow indicates the flow control type as defined above.
-- Note: the timeout precision may be limited on some implementation
-- (e.g. on GNU/Linux the maximum precision is a tenth of seconds).
-- Note: calling this procedure may reinitialize the serial port hardware
-- and thus cause loss of some buffered data if used during communication.
overriding procedure Read
(Port : in out Serial_Port;
Buffer : out Ada.Streams.Stream_Element_Array;
Last : out Ada.Streams.Stream_Element_Offset);
-- Read a set of bytes, put result into Buffer and set Last accordingly.
-- Last is set to Buffer'First - 1 if no byte has been read, unless
-- Buffer'First = Stream_Element_Offset'First, in which case the exception
-- Constraint_Error is raised instead.
overriding procedure Write
(Port : in out Serial_Port;
Buffer : Ada.Streams.Stream_Element_Array);
-- Write buffer into the port
procedure Close (Port : in out Serial_Port);
-- Close port
procedure To_Ada (Port : out Serial_Port; Fd : Serial_Port_Descriptor)
with Inline;
-- Convert a serial port descriptor to Serial_Port. This is useful when a
-- serial port descriptor is obtained from an external library call.
function To_C
(Port : Serial_Port) return Serial_Port_Descriptor with Inline;
-- Return a serial port descriptor to be used by external subprograms.
-- This is useful for C functions that are not yet interfaced in this
-- package.
private
type Serial_Port is new Ada.Streams.Root_Stream_Type with record
H : Serial_Port_Descriptor := -1;
end record;
Data_Rate_Value : constant array (Data_Rate) of Interfaces.C.unsigned :=
[B75 => 75,
B110 => 110,
B150 => 150,
B300 => 300,
B600 => 600,
B1200 => 1_200,
B2400 => 2_400,
B4800 => 4_800,
B9600 => 9_600,
B19200 => 19_200,
B38400 => 38_400,
B57600 => 57_600,
B115200 => 115_200,
B230400 => 230_400,
B460800 => 460_800,
B500000 => 500_000,
B576000 => 576_000,
B921600 => 921_600,
B1000000 => 1_000_000,
B1152000 => 1_152_000,
B1500000 => 1_500_000,
B2000000 => 2_000_000,
B2500000 => 2_500_000,
B3000000 => 3_000_000,
B3500000 => 3_500_000,
B4000000 => 4_000_000];
function To_C (Port : Serial_Port) return Serial_Port_Descriptor is
(Port.H);
end GNAT.Serial_Communications;
|
