comparison gsm-fw/cdg/sap/pkt.pdf @ 652:a39ec5bb5549

gsm-fw/cdg: imported MDF and PDF files from LoCosto, along with XML sources
author Michael Spacefalcon <msokolov@ivan.Harhan.ORG>
date Thu, 25 Sep 2014 08:46:13 +0000
parents
children
comparison
equal deleted inserted replaced
651:806828641b21 652:a39ec5bb5549
1 ;********************************************************************************
2 ;*** File : pkt.pdf
3 ;*** Creation : Wed Mar 11 09:58:35 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 : pkt
9 ;*** Document No. : 8443.105.02.106
10 ;*** Document Date : 2002-10-17
11 ;*** Document Status: BEING_PROCESSED
12 ;*** Document Author: HM
13 ;********************************************************************************
14
15
16
17 PRAGMA SRC_FILE_TIME "Thu Nov 29 09:50:46 2007"
18 PRAGMA LAST_MODIFIED "2002-10-17"
19 PRAGMA ID_AND_VERSION "8443.105.02.106"
20
21
22
23 CONST DIO_MAX_NAME_LENGTH 16 ; arbitrary, in simulation only
24 CONST DIO_MAX_DATA_LENGTH 100 ; arbitrary, in simulation only
25
26
27
28 VALTAB VAL_sleep_mode
29 VAL 0x01 DIO_SLEEP_ENABLE "Enter sleep mode if possible."
30 VAL 0x02 DIO_SLEEP_DISABLE "Do not enter sleep mode."
31
32 VALTAB VAL_parity
33 VAL 0x01 DIO_PARITY_NO "Don't send a parity bit."
34 VAL 0x02 DIO_PARITY_ODD "Send an odd parity bit."
35 VAL 0x04 DIO_PARITY_EVEN "Send an even parity bit."
36 VAL 0x08 DIO_PARITY_SPACE "Send a space for parity bit."
37
38 VALTAB VAL_flow_control
39 VAL 0x0001 DIO_FLOW_NO_NO "No flow control for both directions."
40 VAL 0x0002 DIO_FLOW_SW_NO "Software flow control for receive direction and no flow control for transmit direction."
41 VAL 0x0004 DIO_FLOW_HW_NO "Hardware flow control for receive direction and no flow control for transmit direction."
42 VAL 0x0008 DIO_FLOW_NO_SW "No flow control for receive direction and software flow control for transmit direction."
43 VAL 0x0010 DIO_FLOW_SW_SW "Software flow control for both directions."
44 VAL 0x0020 DIO_FLOW_HW_SW "Hardware flow control for receive direction and software flow control for transmit direction."
45 VAL 0x0040 DIO_FLOW_NO_HW "No flow control for receive direction and hardware flow control for transmit direction."
46 VAL 0x0080 DIO_FLOW_SW_HW "Software flow control for receive direction and hardware flow control for transmit direction."
47 VAL 0x0100 DIO_FLOW_HW_HW "Hardware flow control for both directions."
48
49 VALTAB VAL_data_mode
50 VAL 0x01 DIO_MODE_AT "The TE will transmit AT commands."
51 VAL 0x02 DIO_MODE_DATA "The TE will transmit data."
52 VAL 0x04 DIO_MODE_TRACE "The TE expects trace information via this device"
53 VAL 0x03 DIO_MODE_DEFAULT "Default value if the driver can not provide this information"
54
55 VALTAB VAL_stop_bits
56 VAL 0x01 DIO_STOP_1 "Send 1 stop bit."
57 VAL 0x02 DIO_STOP_15 "Send 1.5 stop bits."
58 VAL 0x04 DIO_STOP_2 "Send 2 stop bits."
59
60 VALTAB VAL_baud
61 VAL 0x00080000 DIO_BAUD_812500 "Transmission rate of 812500 bits/sec."
62 VAL 0x00040000 DIO_BAUD_406250 "Transmission rate of 406250 bits/sec."
63 VAL 0x00020000 DIO_BAUD_203125 "Transmission rate of 203125 bits/sec."
64 VAL 0x00010000 DIO_BAUD_115200 "Transmission rate of 115200 bits/sec."
65 VAL 0x00008000 DIO_BAUD_57600 "Transmission rate of 57600 bits/sec."
66 VAL 0x00004000 DIO_BAUD_38400 "Transmission rate of 38400 bits/sec."
67 VAL 0x00002000 DIO_BAUD_33900 "Transmission rate of 33900 bits/sec."
68 VAL 0x00001000 DIO_BAUD_28800 "Transmission rate of 28800 bits/sec."
69 VAL 0x00000800 DIO_BAUD_19200 "Transmission rate of 19200 bits/sec."
70 VAL 0x00000400 DIO_BAUD_14400 "Transmission rate of 14400 bits/sec."
71 VAL 0x00000200 DIO_BAUD_9600 "Transmission rate of 9600 bits/sec."
72 VAL 0x00000100 DIO_BAUD_7200 "Transmission rate of 7200 bits/sec."
73 VAL 0x00000080 DIO_BAUD_4800 "Transmission rate of 4800 bits/sec."
74 VAL 0x00000040 DIO_BAUD_2400 "Transmission rate of 2400 bits/sec."
75 VAL 0x00000020 DIO_BAUD_1200 "Transmission rate of 1200 bits/sec."
76 VAL 0x00000010 DIO_BAUD_600 "Transmission rate of 600 bits/sec."
77 VAL 0x00000008 DIO_BAUD_300 "Transmission rate of 300 bits/sec."
78 VAL 0x00000004 DIO_BAUD_150 "Transmission rate of 150 bits/sec."
79 VAL 0x00000002 DIO_BAUD_75 "Transmission rate of 75 bits/sec."
80 VAL 0x00000001 DIO_BAUD_AUTO "Automatic detection."
81
82 VALTAB VAL_mux_configuration
83 VAL 0x01 DIO_MUX_MODE_BASIC "The multiplexer supports Basic option."
84 VAL 0x02 DIO_MUX_MODE_ADVANCED "The multiplexer supports Advanced option."
85 VAL 0x04 DIO_MUX_SUBSET_UIH "The multiplexer supports UIH frames."
86 VAL 0x08 DIO_MUX_SUBSET_UI "The multiplexer supports UI frames."
87 VAL 0x10 DIO_MUX_SUBSET_I "The multiplexer supports I frames."
88
89 VALTAB VAL_guard_period
90 VAL 0 DIO_ESC_OFF "Turn escape sequence detection off."
91
92 VALTAB VAL_data_bits
93 VAL 0x10 DIO_CHAR_5 "Send 5 bits per character."
94 VAL 0x20 DIO_CHAR_6 "Send 6 bits per character."
95 VAL 0x40 DIO_CHAR_7 "Send 7 bits per character."
96 VAL 0x80 DIO_CHAR_8 "Send 8 bits per character."
97
98 VALTAB VAL_convergence
99 VAL 0x01 DIO_CONV_SER "The device can contain serial data."
100 VAL 0x02 DIO_CONV_PACKET "The device can contain packet data."
101 VAL 0x04 DIO_CONV_MUX "The device can start a multiplexer."
102
103 VALTAB VAL_state
104 VAL 0x80000000 DIO_SA "read/write, Device ready"
105 VAL 0x40000000 DIO_SB "read/write, Data valid"
106 VAL 0x20000000 DIO_X "read/write, Flow control"
107 VAL 0x10000000 DIO_RING "write, RING indicator"
108 VAL 0x08000000 DIO_ESC "read, escape sequence detected"
109 VAL 0x04000000 DIO_DISC "read, link disconnected"
110 VAL 0x01000000 DIO_MUX_STOP "read/write, stop the multiplexer"
111 VAL 0x02000000 DIO_BRK "read/write, break received / to be sent"
112 VAL 0x000000FF DIO_BRKLEN "read/write, length of the break signal in characters"
113 VAL 0x00000000 DIO_PACKET_UNKNOWN "Packet transfer: No packet type available."
114 VAL 0x00000021 DIO_PACKET_IP "Packet transfer: Simple IP packet"
115 VAL 0x0000002D DIO_PACKET_CTCP "Packet transfer: Van Jacobson compressed TCP/IP header"
116 VAL 0x0000002F DIO_PACKET_UTCP "Packet transfer: Van Jacobson uncompressed TCP/IP header"
117
118 VALTAB VAL_cause
119 VAL 0xD200 PKTCS_SUCCESS "0b11010010 00000000 No error, success"
120 VAL 0xD201 PKTCS_INVALID_PARAMS "0b11010010 00000001 Device number invalid"
121 VAL 0xD202 PKTCS_INVALID_PEER "0b11010010 00000010 Peer does not exist"
122 VAL 0xD203 PKTCS_DISCONNECT "0b11010010 00000011 The driver signalled a DRV_SIGTYPE_DISCONNECT"
123 VAL 0xD204 PKTCS_INTERNAL_DRV_ERROR "0b11010010 00000100 A driver function returned DRV_INTERNAL_ERROR"
124
125
126
127
128 VAR convergence "serial data and / or packet data" B
129
130 VAL @p_pkt - VAL_convergence@
131
132 VAR data_mode "TE will use the device to transmit AT commands or data or both" B
133
134 VAL @p_pkt - VAL_data_mode@
135
136 VAR sleep_mode "describes if the device is able to enter sleep mode" B
137
138 VAL @p_pkt - VAL_sleep_mode@
139
140 VAR mux_configuration "describes the supported configurations of the multiplexer" L
141
142 VAL @p_pkt - VAL_mux_configuration@
143
144 VAR n1 "maximum frame size of a multiplexer frame" S
145
146
147 VAR n2 "maximum number of retransmissions" B
148
149
150 VAR t1 "acknowledgement timer" B
151
152
153 VAR t2 "response timer for the multiplexer control channel" B
154
155
156 VAR t3 "wake up response timer" B
157
158
159 VAR k "window size for advanced option with error recovery" B
160
161
162 VAR mtu "Maximum Transfer Unit" S
163
164
165 VAR baud "supported transmission rates" L
166
167 VAL @p_pkt - VAL_baud@
168
169 VAR data_bits "supported numbers of bits per character" B
170
171 VAL @p_pkt - VAL_data_bits@
172
173 VAR stop_bits "supported number of stop bits" B
174
175 VAL @p_pkt - VAL_stop_bits@
176
177 VAR parity "supported types of parity checking" B
178
179 VAL @p_pkt - VAL_parity@
180
181 VAR flow_control "supported types of flow control" S
182
183 VAL @p_pkt - VAL_flow_control@
184
185 VAR xon "XON character" B
186
187
188 VAR xoff "XOFF character" B
189
190
191 VAR esc_char "ASCII character which could appear three times as an escape sequence" B
192
193
194 VAR guard_period "minimal duration before and after escape sequence" S
195
196 VAL @p_pkt - VAL_guard_period@
197
198 VAR l_buf "length of content in bit" S
199
200
201 VAR o_buf "offset of content in bit" S
202
203
204 VAR buf "test data" B
205
206
207 VAR signal_type "Signal type" S
208
209
210 VAR drv_handle "Unique handle for this driver" S
211
212
213 VAR retval "Return value" S
214
215
216 VAR device_no "Data device number" B
217
218
219 VAR buffer_type "Type of buffer to be cleared" S
220
221
222 VAR state "Line state bits" L
223
224 VAL @p_pkt - VAL_state@
225
226 VAR mask "Line state mask" L
227
228 VAL @p_pkt - VAL_state@
229
230 VAR cause "Cause value" S
231
232 VAL @p_pkt - VAL_cause@
233
234 VAR peer "Name of peer, to be casted to 'const char *'" L
235
236
237 VAR link_id "Link identifier" L
238
239
240 VAR dti_direction "DTI direction" B
241
242
243
244
245
246 COMP dio_dcb "Device Control Block data"
247 {
248 convergence ; serial data and / or packet data
249 data_mode ; TE will use the device to transmit AT commands or data or both
250 sleep_mode ; describes if the device is able to enter sleep mode
251 mux_configuration ; describes the supported configurations of the multiplexer
252 n1 ; maximum frame size of a multiplexer frame
253 n2 ; maximum number of retransmissions
254 t1 ; acknowledgement timer
255 t2 ; response timer for the multiplexer control channel
256 t3 ; wake up response timer
257 k ; window size for advanced option with error recovery
258 mtu ; Maximum Transfer Unit
259 baud ; supported transmission rates
260 data_bits ; supported numbers of bits per character
261 stop_bits ; supported number of stop bits
262 parity ; supported types of parity checking
263 flow_control ; supported types of flow control
264 xon ; XON character
265 xoff ; XOFF character
266 esc_char ; ASCII character which could appear three times as an escape sequence
267 guard_period ; minimal duration before and after escape sequence
268 }
269
270
271
272 COMP sdu "test data"
273 {
274 l_buf ; length of content in bit
275 o_buf ; offset of content in bit
276 buf [1] ; test data
277 }
278
279
280
281
282
283
284 ; PKT_CONNECT_IND 0x80004045
285 ; PKT_CONNECT_RES 0x80000045
286 ; PKT_CONNECT_REJ 0x80010045
287 ; PKT_DISCONNECT_IND 0x80014045
288 ; PKT_DTI_OPEN_REQ 0x80020045
289 ; PKT_DTI_OPEN_CNF 0x80024045
290 ; PKT_MODIFY_REQ 0x80030045
291 ; PKT_MODIFY_CNF 0x80034045
292 ; PKT_DTI_CLOSE_REQ 0x80040045
293 ; PKT_DTI_CLOSE_CNF 0x80044045
294 ; PKT_DTI_CLOSE_IND 0x80054045
295 ; PKT_SIG_CLEAR_IND 0x80050045
296 ; PKT_SIG_FLUSH_IND 0x80060045
297 ; PKT_SIG_READ_IND 0x80070045
298 ; PKT_SIG_WRITE_IND 0x80080045
299 ; PKT_SIG_CONNECT_IND 0x80090045
300 ; PKT_SIG_DISCONNECT_IND 0x800A0045
301 ; PKT_DIO_SIGNAL_IND 0x80200045
302 ; PKT_DIO_INIT_REQ 0x80204045
303 ; PKT_DIO_INIT_CNF 0x80210045
304 ; PKT_DIO_EXIT_REQ 0x80214045
305 ; PKT_DIO_READ_REQ 0x80224045
306 ; PKT_DIO_READ_CNF 0x80220045
307 ; PKT_DIO_GETDATA_REQ 0x80234045
308 ; PKT_DIO_GETDATA_CNF 0x80230045
309 ; PKT_DIO_WRITE_REQ 0x80244045
310 ; PKT_DIO_WRITE_CNF 0x80240045
311 ; PKT_DIO_GETBUFFER_REQ 0x80254045
312 ; PKT_DIO_GETBUFFER_CNF 0x80250045
313 ; PKT_DIO_CLEAR_REQ 0x80264045
314 ; PKT_DIO_CLEAR_CNF 0x80260045
315 ; PKT_DIO_FLUSH_REQ 0x80274045
316 ; PKT_DIO_FLUSH_CNF 0x80270045
317 ; PKT_DIO_SETSIGNAL_REQ 0x80284045
318 ; PKT_DIO_SETSIGNAL_CNF 0x80280045
319 ; PKT_DIO_RESETSIGNAL_REQ 0x80294045
320 ; PKT_DIO_RESETSIGNAL_CNF 0x80290045
321 ; PKT_DIO_GETCAP_REQ 0x802A4045
322 ; PKT_DIO_GETCAP_CNF 0x802A0045
323 ; PKT_DIO_SETCONFIG_REQ 0x802B4045
324 ; PKT_DIO_SETCONFIG_CNF 0x802B0045
325 ; PKT_DIO_GETCONFIG_REQ 0x802C4045
326 ; PKT_DIO_GETCONFIG_CNF 0x802C0045
327 ; PKT_DIO_CLOSEDEVICE_REQ 0x802D4045
328 ; PKT_DIO_CLOSEDEVICE_CNF 0x802D0045
329
330
331
332 PRIM PKT_CONNECT_IND 0x80004045
333 {
334 device_no ; Device number
335 dio_dcb ; Device Control Block data
336 }
337
338
339
340
341
342
343 PRIM PKT_CONNECT_RES 0x80000045
344 {
345 device_no ; Device number
346 dio_dcb ; Device Control Block data
347 }
348
349
350
351
352
353
354 PRIM PKT_CONNECT_REJ 0x80010045
355 {
356 device_no ; Device number
357 }
358
359
360
361
362
363
364 PRIM PKT_DISCONNECT_IND 0x80014045
365 {
366 device_no ; Device number
367 cause ; Cause value
368 }
369
370
371
372
373
374
375 PRIM PKT_DTI_OPEN_REQ 0x80020045
376 {
377 device_no ; Device number
378 peer ; Peer
379 link_id ; Link identifier
380 dti_direction ; DTI direction
381 }
382
383
384
385
386
387
388 PRIM PKT_DTI_OPEN_CNF 0x80024045
389 {
390 device_no ; Device number
391 cause ; Cause value
392 }
393
394
395
396
397
398
399 PRIM PKT_MODIFY_REQ 0x80030045
400 {
401 device_no ; Device number
402 dio_dcb ; Device Control Block data
403 }
404
405
406
407
408
409
410 PRIM PKT_MODIFY_CNF 0x80034045
411 {
412 device_no ; Device number
413 cause ; Cause value
414 }
415
416
417
418
419
420
421 PRIM PKT_DTI_CLOSE_REQ 0x80040045
422 {
423 device_no ; Device number
424 }
425
426
427
428
429
430
431 PRIM PKT_DTI_CLOSE_CNF 0x80044045
432 {
433 device_no ; Device number
434 }
435
436
437
438
439
440
441 PRIM PKT_DTI_CLOSE_IND 0x80054045
442 {
443 device_no ; Device number
444 }
445
446
447
448
449
450
451 PRIM PKT_SIG_CLEAR_IND 0x80050045
452 {
453 }
454
455
456
457
458
459
460 PRIM PKT_SIG_FLUSH_IND 0x80060045
461 {
462 }
463
464
465
466
467
468
469 PRIM PKT_SIG_READ_IND 0x80070045
470 {
471 }
472
473
474
475
476
477
478 PRIM PKT_SIG_WRITE_IND 0x80080045
479 {
480 }
481
482
483
484
485
486
487 PRIM PKT_SIG_CONNECT_IND 0x80090045
488 {
489 }
490
491
492
493
494
495
496 PRIM PKT_SIG_DISCONNECT_IND 0x800A0045
497 {
498 }
499
500
501
502
503
504
505 PRIM PKT_DIO_SIGNAL_IND 0x80200045
506 {
507 device_no ; Data device number
508 signal_type ; Signal type
509 }
510
511
512
513
514
515
516 PRIM PKT_DIO_INIT_REQ 0x80204045
517 {
518 drv_handle ; Driver handle
519 }
520
521
522
523
524
525
526 PRIM PKT_DIO_INIT_CNF 0x80210045
527 {
528 retval ; Return value
529 }
530
531
532
533
534
535
536 PRIM PKT_DIO_EXIT_REQ 0x80214045
537 {
538 }
539
540
541
542
543
544
545 PRIM PKT_DIO_READ_REQ 0x80224045
546 {
547 device_no ; Data Device number
548 }
549
550
551
552
553
554
555 PRIM PKT_DIO_READ_CNF 0x80220045
556 {
557 retval ; return value
558 }
559
560
561
562
563
564
565 PRIM PKT_DIO_GETDATA_REQ 0x80234045
566 {
567 device_no ; Data Device number
568 }
569
570
571
572
573
574
575 PRIM PKT_DIO_GETDATA_CNF 0x80230045
576 {
577 retval ; return value
578 state ; Line state
579 sdu ; Data descriptor equivalent
580 }
581
582
583
584
585
586
587 PRIM PKT_DIO_WRITE_REQ 0x80244045
588 {
589 device_no ; Data Device number
590 state ; State
591 mask ; Mask
592 sdu ; Data descriptor equivalent
593 }
594
595
596
597
598
599
600 PRIM PKT_DIO_WRITE_CNF 0x80240045
601 {
602 retval ; return value
603 }
604
605
606
607
608
609
610 PRIM PKT_DIO_GETBUFFER_REQ 0x80254045
611 {
612 device_no ; Data Device number
613 }
614
615
616
617
618
619
620 PRIM PKT_DIO_GETBUFFER_CNF 0x80250045
621 {
622 retval ; return value
623 }
624
625
626
627
628
629
630 PRIM PKT_DIO_CLEAR_REQ 0x80264045
631 {
632 device_no ; Data device number
633 buffer_type ; Buffer type
634 }
635
636
637
638
639
640
641 PRIM PKT_DIO_CLEAR_CNF 0x80260045
642 {
643 retval ; return value
644 }
645
646
647
648
649
650
651 PRIM PKT_DIO_FLUSH_REQ 0x80274045
652 {
653 device_no ; Data device number
654 }
655
656
657
658
659
660
661 PRIM PKT_DIO_FLUSH_CNF 0x80270045
662 {
663 retval ; return value
664 }
665
666
667
668
669
670
671 PRIM PKT_DIO_SETSIGNAL_REQ 0x80284045
672 {
673 signal_type ; Signal type
674 }
675
676
677
678
679
680
681 PRIM PKT_DIO_SETSIGNAL_CNF 0x80280045
682 {
683 retval ; return value
684 }
685
686
687
688
689
690
691 PRIM PKT_DIO_RESETSIGNAL_REQ 0x80294045
692 {
693 signal_type ; Signal type
694 }
695
696
697
698
699
700
701 PRIM PKT_DIO_RESETSIGNAL_CNF 0x80290045
702 {
703 retval ; return value
704 }
705
706
707
708
709
710
711 PRIM PKT_DIO_GETCAP_REQ 0x802A4045
712 {
713 device_no ; Data device number
714 }
715
716
717
718
719
720
721 PRIM PKT_DIO_GETCAP_CNF 0x802A0045
722 {
723 retval ; return value
724 dio_dcb ; Device Control Block
725 }
726
727
728
729
730
731
732 PRIM PKT_DIO_SETCONFIG_REQ 0x802B4045
733 {
734 device_no ; Data device number
735 dio_dcb ; Device Control Block
736 }
737
738
739
740
741
742
743 PRIM PKT_DIO_SETCONFIG_CNF 0x802B0045
744 {
745 retval ; return value
746 }
747
748
749
750
751
752
753 PRIM PKT_DIO_GETCONFIG_REQ 0x802C4045
754 {
755 device_no ; Data device number
756 }
757
758
759
760
761
762
763 PRIM PKT_DIO_GETCONFIG_CNF 0x802C0045
764 {
765 retval ; return value
766 }
767
768
769
770
771
772
773 PRIM PKT_DIO_CLOSEDEVICE_REQ 0x802D4045
774 {
775 device_no ; Data device number
776 }
777
778
779
780
781
782
783 PRIM PKT_DIO_CLOSEDEVICE_CNF 0x802D0045
784 {
785 retval ; return value
786 }
787
788
789
790
791
792
793
794
795