Merge from vendor branch HEIMDAL:
[dragonfly.git] / share / examples / atm / sscf-design.txt
1
2         SSCF UNI Design
3         ===============
4
5 SAP_SSCF_UNI Interface
6 ----------------------
7 This is the stack SAP interface between the UNI signalling layer (eg. Q.2931)
8 and the SSCF module.  The stack commands defined for this interface are modeled
9 after the SSCF protocol specification primitives AAL-xxx.  See the protocol
10 specification documents referenced below for full descriptions of the SSCF UNI
11 interface presented to the signalling user.
12
13
14 o The following stack commands are sent from the signalling module to SSCF:
15
16 Stack Command:  SSCF_UNI_INIT
17 Description:    Initialize a SAP instance.  This should be the first stack
18                 command issued across the SAP instance after the service stack
19                 has been successfully instantiated.
20 Argument 1:     Specifies the UNI version to be used for this stack instance.
21                 (enum uni_vers)
22 Argument 2:     Not used.
23
24
25 Stack Command:  SSCF_UNI_TERM
26 Description:    Terminate a SAP instance.  This must be the last stack command
27                 issued across the SAP instance.  The stack instance will be
28                 deleted upon completion of this command.
29 Argument 1:     Not used.
30 Argument 2:     Not used.
31
32
33 Stack Command:  SSCF_UNI_ESTABLISH_REQ
34 Description:    Request the establishment of an assured SAAL connection to the
35                 SAAL peer entity.
36 Argument 1:     Not used.
37 Argument 2:     Not used.
38
39
40 Stack Command:  SSCF_UNI_RELEASE_REQ
41 Description:    Request the termination of an assured SAAL connection to the
42                 SAAL peer entity.
43 Argument 1:     Specifies whether future session establishment indications from
44                 the SAAL peer should be processed.  Valid values are 
45                 SSCF_UNI_ESTIND_YES or SSCF_UNI_ESTIND_NO. (int)
46                 Note that this is a local implementation parameter only.
47 Argument 2:     Not used.
48
49
50 Stack Command:  SSCF_UNI_DATA_REQ
51 Description:    Request that an assured SDU be sent to the SAAL peer.
52 Argument 1:     Pointer to an mbuf chain containing the user SDU.
53                 (struct mbuf *)
54 Argument 2:     Not used.
55
56
57 Stack Command:  SSCF_UNI_UNITDATA_REQ
58 Description:    Request that an unacknowledged SDU be sent to the SAAL peer.
59 Argument 1:     Pointer to an mbuf chain containing the user SDU.
60                 (struct mbuf *)
61 Argument 2:     Not used.
62
63
64 o The following stack commands are sent from SSCF to the signalling module:
65
66 Stack Command:  SSCF_UNI_ESTABLISH_IND
67 Description:    Indication that an assured SAAL connection has been established
68                 by the SAAL peer entity.
69 Argument 1:     Not used.
70 Argument 2:     Not used.
71
72
73 Stack Command:  SSCF_UNI_ESTABLISH_CNF
74 Description:    Confirmation of an assured SAAL connection establishment,
75                 previously requested via an SSCF_UNI_ESTABLISH_REQ command.
76 Argument 1:     Not used.
77 Argument 2:     Not used.
78
79
80 Stack Command:  SSCF_UNI_RELEASE_IND
81 Description:    Indication that an assured SAAL connection has been terminated
82                 by the SAAL peer entity.
83 Argument 1:     Not used.
84 Argument 2:     Not used.
85
86
87 Stack Command:  SSCF_UNI_RELEASE_CNF
88 Description:    Confirmation of an assured SAAL connection termination,
89                 previously requested via an SSCF_UNI_RELEASE_REQ command.
90 Argument 1:     Not used.
91 Argument 2:     Not used.
92
93
94 Stack Command:  SSCF_UNI_DATA_IND
95 Description:    Indication that an assured SDU has been received from the 
96                 SAAL peer.
97 Argument 1:     Pointer to an mbuf chain containing the peer's SDU.
98                 (struct mbuf *)
99 Argument 2:     Not used.
100
101
102 Stack Command:  SSCF_UNI_UNITDATA_IND
103 Description:    Indication that an unacknowledged SDU has been received from 
104                 the SAAL peer.
105 Argument 1:     Pointer to an mbuf chain containing the peer's SDU.
106                 (struct mbuf *)
107 Argument 2:     Not used.
108
109
110
111 Protocol Specifications
112 -----------------------
113 For UNI_VERS_3_0, see Q.SAAL2.
114 For UNI_VERS_3_1, see Q.2130.
115
116
117
118 Implementation Limitations
119 --------------------------
120 o The Parameter Data parameter is not supported for the following primitives:
121         AAL-ESTABLISH request
122         AAL-ESTABLISH indication
123         AAL-ESTABLISH confirm
124         AAL-RELEASE request
125         AAL-RELEASE indication
126
127
128         @(#) $FreeBSD: src/share/examples/atm/sscf-design.txt,v 1.2 1999/08/28 00:19:08 peter Exp $
129         @(#) $DragonFly: src/share/examples/atm/sscf-design.txt,v 1.2 2003/06/17 04:36:57 dillon Exp $
130