FreeCalypso > hg > fc-magnetite

comparison cdg-hybrid/sap/dio.pdf @ 212:e7a67accfad9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cdg-hybrid cdginc headers created
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 14 Oct 2016 21:52:58 +0000
parents
children
comparison
equal deleted inserted replaced
211:02269c474131 212:e7a67accfad9
1 ;********************************************************************************
2 ;*** File : DIO.pdf
3 ;*** Creation : Wed Mar 11 09:57:46 CST 2009
4 ;*** XSLT Processor : Apache Software Foundation / http://xml.apache.org/xalan-j / supports XSLT-Ver: 1
5 ;*** Copyright : (c) Texas Instruments AG, Berlin Germany 2002
6 ;********************************************************************************
7 ;*** Document Type : Service Access Point Specification
8 ;*** Document Name : DIO
9 ;*** Document No. : ...
10 ;*** Document Date : 2004-03-19
11 ;*** Document Status: BEING_PROCESSED
12 ;*** Document Author: RM
13 ;********************************************************************************
14
15
16
17 PRAGMA SRC_FILE_TIME "Thu Nov 29 09:39:48 2007"
18 PRAGMA LAST_MODIFIED "2004-03-19"
19 PRAGMA ID_AND_VERSION "..."
20
21
22
23
24
25
26 VALTAB VAL_baud_rate
27 VAL 0x00000000 DIO4_BAUD_RESERVED "reserved value"
28 VAL 0x00000001 DIO4_BAUD_AUTO "Automatic detected"
29 VAL 0x00000002 DIO4_BAUD_75 "Transmission rate of 75 bits/sec"
30 VAL 0x00000004 DIO4_BAUD_110 "Transmission rate of 110 bits/sec"
31 VAL 0x00000008 DIO4_BAUD_150 "Transmission rate of 150 bits/sec"
32 VAL 0x00000010 DIO4_BAUD_300 "Transmission rate of 300 bits/sec"
33 VAL 0x00000020 DIO4_BAUD_600 "Transmission rate of 600 bits/sec"
34 VAL 0x00000040 DIO4_BAUD_1200 "Transmission rate of 1200 bits/sec"
35 VAL 0x00000080 DIO4_BAUD_2400 "Transmission rate of 2400 bits/sec"
36 VAL 0x00000100 DIO4_BAUD_4800 "Transmission rate of 4800 bits/sec"
37 VAL 0x00000200 DIO4_BAUD_7200 "Transmission rate of 7200 bits/sec"
38 VAL 0x00000400 DIO4_BAUD_9600 "Transmission rate of 9600 bits/sec"
39 VAL 0x00000800 DIO4_BAUD_14400 "Transmission rate of 14400 bits/sec"
40 VAL 0x00001000 DIO4_BAUD_19200 "Transmission rate of 19200 bits/se"
41 VAL 0x00002000 DIO4_BAUD_28800 "Transmission rate of 28800 bits/se"
42 VAL 0x00004000 DIO4_BAUD_33900 "Transmission rate of 33900 bits/se"
43 VAL 0x00008000 DIO4_BAUD_38400 "Transmission rate of 38400 bits/se"
44 VAL 0x00010000 DIO4_BAUD_57600 "Transmission rate of 57600 bits/se"
45 VAL 0x00020000 DIO4_BAUD_115200 "Transmission rate of 115200 bits/se"
46 VAL 0x00040000 DIO4_BAUD_203125 "Transmission rate of 203125 bits/se"
47 VAL 0x00080000 DIO4_BAUD_230400 "Transmission rate of 230400 bits/se"
48 VAL 0x00100000 DIO4_BAUD_406250 "Transmission rate of 406250 bits/se"
49 VAL 0x00200000 DIO4_BAUD_460800 "Transmission rate of460800 bits/se"
50 VAL 0x00400000 DIO4_BAUD_812500 "Transmission rate of 812500 bits/se"
51 VAL 0x00800000 DIO4_BAUD_921600 "Transmission rate of 921600 bits/se"
52
53 VALTAB VAL_dev_type
54 VAL 0x00200000 DIO_DATA_MUX "device can start a multiplexer"
55 VAL 0x00400000 DIO_DATA_PKT "device can contain packet data"
56 VAL 0x00800000 DIO_DATA_SER "device can contain serial data"
57 VAL 0x00A0000 DIO_DATA_SER_MUX "serial device which can start a multiplexer"
58 VAL 0x0000ff00 DIO_TYPE_ID_MASK "mask for dio identifier to separate different capability structs with the same combination"
59 VAL 0x00ff0000 DIO_TYPE_DAT_MASK "mask for dio identifier to separate kind of data support"
60 VAL 0x00800100 DIO_TYPE_SER "Type for serial devices like UART"
61 VAL 0x00A00100 DIO_TYPE_SER_MUX "Type for serial devices like UART. It is possible to start a 27.010 multiplexer on devices of this type"
62 VAL 0x00400100 DIO_TYPE_PKT "Type for packet devices"
63
64 VALTAB VAL_char_frame
65 VAL 0x00000001 DIO_CF_8N2 "8 data bits; no parity bit; 2 stop bits"
66 VAL 0x00000002 DIO_CF_8O1 "8 data bits; odd parity bit; 1 stop bits"
67 VAL 0x00000004 DIO_CF_8E1 "8 data bits; even parity bit; 1 stop bits"
68 VAL 0x00000008 DIO_CF_8M1 "8 data bits; mark parity bit; 1 stop bits"
69 VAL 0x00000010 DIO_CF_8S1 "8 data bits; space parity bit; 1 stop bits"
70 VAL 0x00000020 DIO_CF_8N1 "8 data bits; no parity bit; 1 stop bits"
71 VAL 0x00000040 DIO_CF_7N2 "7 data bits; no parity bit; 2 stop bits"
72 VAL 0x00000080 DIO_CF_7O1 "7 data bits; odd parity bit; 1 stop bits"
73 VAL 0x00000100 DIO_CF_7E1 "7 data bits; even parity bit; 1 stop bits"
74 VAL 0x00000200 DIO_CF_7M1 "7 data bits; mark parity bit; 1 stop bits"
75 VAL 0x00000400 DIO_CF_7S1 "7 data bits; space parity bit;1 stop bits"
76 VAL 0x00000800 DIO_CF_7N1 "7 data bits; no parity bit; 1 stop bits"
77
78 VALTAB VAL_flow_control
79 VAL 0x00000001 DIO_FLOW_NONE "Data transmit: None Data receive: None"
80 VAL 0x00000002 DIO_FLOW_NO_XOFF "Data transmit: None Data receive: XON/XOFF"
81 VAL 0x00000004 DIO_FLOW_NO_CTS "Data transmit: None Data receive: CTS"
82 VAL 0x00000008 DIO_FLOW_XON_NO "Data transmit: local XON/XOFF Data receive: None"
83 VAL 0x00000010 DIO_FLOW_XON_XOFF "Data transmit: local XON/XOFF Data receive: XON/XOFF"
84 VAL 0x00000020 DIO_FLOW_XON_CTS "Data transmit: local XON/XOFF Data receive:CTS"
85 VAL 0x00000040 DIO_FLOW_RTS_NO "Data transmit: RTS Data receive: None"
86 VAL 0x00000080 DIO_FLOW_RTS_XOFF "Data transmit: RTS Data receive: XON/XOFF"
87 VAL 0x00000100 DIO_FLOW_RTS_CTS "Data transmit: RTS Data receive: CTS"
88 VAL 0x00000200 DIO_FLOW_XTR_NO "Data transmit: transparent XON/XOFF Data receive: None"
89 VAL 0x00000400 DIO_FLOW_XTR_XOFF "Data transmit: transparent XON/XOFF Data receive: CTS"
90 VAL 0x00000800 DIO_FLOW_XTR_CTS "Data transmit: transparent XON/XOFF Data receive: CTS"
91
92 VALTAB VAL_line_states
93 VAL 0x01 LINE_STD_DCD_ON "b00000001 set line DCD on"
94 VAL 0x02 LINE_STD_DCD_OFF "b00000010 set line DCD off"
95 VAL 0x04 LINE_STD_RING_ON "b00000100 set line RING on"
96 VAL 0x08 LINE_STD_RING_OFF "b00001000 set line RING off"
97 VAL 0x10 LINE_STD_ESCD_IND "b00010000 escape sequence indication"
98 VAL 0x20 LINE_STD_DTR_LDR "b00100000 DTR line drop indication"
99
100 VALTAB VAL_ser_flags
101 VAL 0x80000000 DIO_FLAG_SER_ESC "device supports escape sequence detection"
102
103 VALTAB VAL_device
104 VAL 0xff000000 DIO_DRV_MASK "mask for driver number to identify the driver"
105 VAL 0x00ffff00 DIO_TYPE_MASK "mask for device type"
106 VAL 0x000000ff DIO_DEVICE_MASK "mask for actual device number chosen by the driver"
107 VAL 0x00000000 DIO_DRV_UART "UART driver"
108 VAL 0x01000000 DIO_DRV_USB "USB driver"
109 VAL 0x02000000 DIO_DRV_MUX "27.010 multiplexer driver"
110 VAL 0x03000000 DIO_DRV_PKT "packet driver"
111 VAL 0x04000000 DIO_DRV_MCBSP "McBSP driver"
112 VAL 0x05000000 DIO_DRV_APP "Application adapter"
113 VAL 0x06000000 DIO_DRV_BAT "Binary Interface Adapter"
114
115 VALTAB VAL_dev_flag
116 VAL 0x80000000 DIO_FLAG_SLEEP "device provides the feature power saving state"
117
118 VALTAB VAL_mux_mode
119 VAL 0x00000001 DIO_MUX_BASIC "mux supports Basic option"
120 VAL 0x00000002 DIO_MUX_UIH "mux supports Advanced option with UIH frames"
121 VAL 0x00000004 DIO_MUX_UI "mux supports Advanced option with UI frames"
122 VAL 0x00000008 DIO_MUX_I "mux supports Advanced option with I frames (error recovery)"
123
124 VALTAB VAL_contr_type
125 VAL 0x0001 DIO4_CTRL_LINES "control struct contains serial line states"
126 VAL 0x0002 DIO4_CTRL_MUX "control struct contains mux control parameter"
127
128 VALTAB VAL_dev_mode
129 VAL 0x00000001 DIO_MODE_SER "device acts as serial device"
130 VAL 0x00000002 DIO_MODE_MUX "device acts as 27.010 mux device"
131
132 VALTAB VAL_esc_char
133 VAL 0x2b ESC_CHAR_DEFAULT "default escape character ('+')"
134
135 VALTAB VAL_guard_per
136 VAL 0x00 DIO_ESC_OFF "turn escape sequence detection off"
137 VAL 0x3E8 DIO_GUARD_PER_DEFAULT "default value 1000ms"
138
139 VALTAB VAL_k
140 VAL 0x02 K_DEFAULT "k default value"
141
142 VALTAB VAL_n1
143 VAL 0x1f MUX_N1_BASIC_DEFAULT "default value for the basic option"
144 VAL 0x40 MUX_N1_ADVANCED_DEFAULT "default value for the advanced option"
145
146 VALTAB VAL_n2
147 VAL 0x03 MUX_N2_DEFAULT "default number of retransmission"
148
149 VALTAB VAL_sleep_mode
150 VAL 0x01 DIO_SLEEP_ENABLE "enter sleep mode if possible"
151 VAL 0x02 DIO_SLEEP_DISABLE "do not enter sleep mode"
152
153 VALTAB VAL_cb_line_state
154 VAL 0x80000000 DIO_SA "read/write: device ready"
155 VAL 0x40000000 DIO_SB "read/write: data valid"
156 VAL 0x20000000 DIO_X "read/write: flow control"
157 VAL 0x10000000 DIO_RING "write: RING indicator"
158 VAL 0x08000000 DIO_ESC "read: escape seqence detected"
159 VAL 0x04000000 DIO_MUX_STOPPED "multiplexer stopped"
160 VAL 0x02000000 DIO_BRK "read/write: break received/to be send"
161 VAL 0x000000ff DIO_BRKLEN_MASK "read/write: length of break signal in character; only valid if DIO_BREAK bit is set to 1"
162
163 VALTAB VAL_t1
164 VAL 0x0a MUX_T1_DEFAULT "default acknowledgement timer (100ms)"
165
166 VALTAB VAL_t2
167 VAL 0x1e MUX_T2_DEFAULT "default response timer"
168
169 VALTAB VAL_t3
170 VAL 0x0a MUX_T3_DEFAULT "default wake up response timer (100ms)"
171
172 VALTAB VAL_xoff
173 VAL 0x13 XOFF_DEFAULT "xoff default value"
174
175 VALTAB VAL_xon
176 VAL 0x11 XON_DEFAULT "xon default value"
177
178 VALTAB VAL_start_mux
179 VAL 0x00 DIO_MUX_DYNAMIC "Do not start the 27.010 multiplexer immediately. The multi-plexer may be started dynamically on runtime"
180 VAL 0x01 DIO_MUX_START "Starts the 27.010 multiplexer permanently. The multiplexer can not be turned off during runtime"
181
182
183
184
185 VAR baudrate "user set baudrate" L
186
187 VAL @p_DIO - VAL_baud_rate@
188
189 VAR baudrate_auto "automatically detected driver baudrates" L
190
191 VAL @p_DIO - VAL_baud_rate@
192
193 VAR baudrate_fixed "driver baudrates which cannot be detected automatically" L
194
195 VAL @p_DIO - VAL_baud_rate@
196
197 VAR char_frame "supported character framing" L
198
199 VAL @p_DIO - VAL_char_frame@
200
201 VAR control_type "data types" S
202
203 VAL @p_DIO - VAL_contr_type@
204
205 VAR device_flags "driver features like power saving state" L
206
207 VAL @p_DIO - VAL_dev_flag@
208
209 VAR device_mode "work mode of device" L
210
211 VAL @p_DIO - VAL_dev_mode@
212
213 VAR device_type "device identifier with general capability information" L
214
215 VAL @p_DIO - VAL_dev_type@
216
217 VAR driver_name "pointer to driver name" L
218
219
220 VAR esc_char "ASCII character which is used in an escape sequence" B
221
222 VAL @p_DIO - VAL_esc_char@
223
224 VAR flow_control "supported modes of flow control" L
225
226 VAL @p_DIO - VAL_flow_control@
227
228 VAR guard_period "duration value for escape sequence" S
229
230 VAL @p_DIO - VAL_guard_per@
231
232 VAR k "windows size " B
233
234 VAL @p_DIO - VAL_k@
235
236 VAR length "len of dio_ctrl" S
237
238
239 VAR line_state "line state information" S
240
241 VAL @p_DIO - VAL_line_states@
242
243 VAR mtu_control "max length of copied control information bytes by the driver" S
244
245
246 VAR mtu_data "max size of packet data which the driver can transfer" S
247
248
249 VAR mux_mode "supported multiplexer modes" L
250
251 VAL @p_DIO - VAL_mux_mode@
252
253 VAR n1 "max frame size of mux frame" S
254
255 VAL @p_DIO - VAL_n1@
256
257 VAR n2 "max number of retransmissions" B
258
259 VAL @p_DIO - VAL_n2@
260
261 VAR ser_flags "additional supported features of serial/mux devices" L
262
263 VAL @p_DIO - VAL_ser_flags@
264
265 VAR sleep_mode "enter sleep mode is possible or not" B
266
267 VAL @p_DIO - VAL_sleep_mode@
268
269 VAR state "line states" L
270
271 VAL @p_DIO - VAL_cb_line_state@
272
273 VAR t1 "acknowledgement timer" B
274
275 VAL @p_DIO - VAL_t1@
276
277 VAR t2 "response timer" B
278
279 VAL @p_DIO - VAL_t2@
280
281 VAR t3 "wake up response timer" B
282
283 VAL @p_DIO - VAL_t3@
284
285 VAR xoff "set/reset XOFF for flow control" B
286
287
288 VAR xon "set/reset XON for flow control" B
289
290
291 VAR return_val "return values are defined in gdi.h" S
292
293
294 VAR c_data "the size of the data" S
295
296
297 VAR data " pointer to the first byte of the data buffer segment" B
298
299
300 VAR c_dio_segment "the number of segments" B
301
302
303 VAR device "Data device number" L
304
305
306 VAR user_name "Basic Element" L
307
308
309 VAR drv_handle "Basic Element" S
310
311
312
313
314
315 COMP DIO_DCB_SER "Structured Element"
316 {
317 device_type ; device identifier
318 sleep_mode ; power saving mechanism mode
319 baudrate ; transmission data rate
320 char_frame ; character framing mode
321 flow_control ; flow control mode
322 xon ; inband flow control mode
323 xoff ; inband flow control mode
324 esc_char ; ASCII character of escape sequence
325 guard_period ; minimal duration before first and after last esc_char
326 }
327
328
329
330 COMP DIO_DCB_SER_MUX "Structured Element"
331 {
332 device_type ; device identifier
333 sleep_mode ; power saving mechanism mode
334 baudrate ; transmission data rate
335 char_frame ; character framing mode
336 flow_control ; flow control mode
337 xon ; inband flow control mode
338 xoff ; inband flow control mode
339 esc_char ; ASCII character of escape sequence
340 guard_period ; minimal duration before first and after last esc_char
341 device_mode ; device work mode: serial or mux
342 mux_mode ; multiplexer mode of 27.010
343 n1 ; max frame size of mux frame
344 n2 ; max number of retransmissions
345 t1 ; acknowledgement timer
346 t2 ; response timer of mux control channel
347 t3 ; wake up response timer
348 k ; windows size for advanced option with error recovery
349 }
350
351
352
353 COMP DIO_DCB_PKT "Structured Element"
354 {
355 device_type ; device identifier
356 sleep_mode ; power saving mechanism mode
357 }
358
359
360
361 COMP DIO_CAP_SER "serial device capabiliity structures"
362 {
363 device_type ; device identifier
364 device_flags ; general additional capabilities
365 mtu_control ; max number of bytes driver copies
366 mtu_data ; max size of packet driver transfers
367 driver_name ; pointer to zero terminated string with driver name
368 baudrate_auto ; transmission rate automatically detected
369 baudrate_fixed ; transmission rate can be only set
370 char_frame ; supported character frame modes
371 flow_control ; supported flow control modes
372 ser_flags ; supported serial device capabilites
373 }
374
375
376
377 COMP DIO_CAP_SER_MUX "Structured Element"
378 {
379 device_type ; device identifier
380 device_flags ; general additional capabilities
381 mtu_control ; max number of bytes driver copies
382 mtu_data ; max size of packet driver transfers
383 driver_name ; pointer to zero terminated string with driver name
384 baudrate_auto ; transmission rate automatically detected
385 baudrate_fixed ; transmission rate can be only set
386 char_frame ; supported character frame modes
387 flow_control ; supported flow control modes
388 ser_flags ; supported serial device capabilites
389 mux_mode ; supported mux mode of 27.010
390 }
391
392
393
394 COMP DIO_CAP_PKT "Structured Element"
395 {
396 device_type ; device identifier
397 device_flags ; general additional capabilities
398 mtu_control ; max number of bytes driver copies
399 mtu_data ; max size of packet driver transfers
400 driver_name ; pointer to zero terminated string with driver name
401 }
402
403
404
405 COMP DIO_CAP "device capabiliity structures"
406 {
407 device_type ; device identifier
408 device_flags ; general additional capabilities
409 mtu_control ; max number of bytes driver copies
410 mtu_data ; max size of packet driver transfers
411 driver_name ; pointer to zero terminated string with driver name
412 }
413
414
415
416 COMP DIO_DCB "all elements of driver configuration parameter "
417 {
418 device_type ; device identifier
419 sleep_mode ; power saving mechanism mode
420 }
421
422
423
424 COMP dio_segment "Structured Element"
425 {
426 data PTR [0..65335] ; pointer to the first byte of the data buffer segment
427 }
428
429
430
431 COMP dio_buffer "data buffer"
432 {
433 length ; number of data bytes (writable or provided)
434 dio_segment PTR [0..255] ; pointer to array of segments
435 }
436
437
438
439 COMP DIO_CTRL "Structured Element"
440 {
441 control_type ; identifier of control info structure
442 length ; length of whole control info structure
443 }
444
445
446
447 COMP DIO_CTRL_LINES "Structured Element"
448 {
449 control_type ; control type of serial line states
450 length ; length of control info structure
451 state ; set/hold serial line states
452 }
453
454
455
456 COMP DIO_CTRL_MUX "Structured Element"
457 {
458 control_type ; control type of mux line states
459 length ; length of control info structure
460 state ; set/hold mux line states
461 }
462
463
464
465
466
467
468
469
470
471
472
473