FreeCalypso > hg > fc-magnetite

comparison cdg3/sap/8010_157_upm_sap.sap @ 16:c15047b3d00d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cdg3: import from freecalypso-citrine/cdg
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 27 Sep 2016 16:27:34 +0000
parents
children
comparison
equal deleted inserted replaced
15:c8bdae60fcb1 16:c15047b3d00d
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- edited with SAPE SAP Editor -->
3 <SAP xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="sap.xsd">
4 <DocInfoSection>
5 <DocName DocType="SAP">8010_157_upm_sap</DocName>
6 <DocNum Number="157" Project="8010"/>
7 <Description>
8 <Section>This document is part of the High Level Design (HLD) for the Texas Instruments Dual-mode protocol stack. The document describes the service access point between the UPM entity and ACI.</Section>
9 <Section>This SAP is used by the DTI manager to control the UPM DTI connections and by ACI for getting information about the user plane data flow.</Section>
10 </Description>
11 <DocHistory>
12 <DocVersion Number="001" Year="04"/>
13 <Date Day="7" Month="1" Year="2004"/>
14 <Author>MVJ</Author>
15 <DocStatus State="BEING_PROCESSED"/>
16 <Comment>Initial version.</Comment>
17 </DocHistory>
18 <DocHistory>
19 <DocVersion Number="002" Year="04"/>
20 <Date Day="12" Month="1" Year="2004"/>
21 <Author>MVJ</Author>
22 <DocStatus State="BEING_PROCESSED"/>
23 <Comment>Added UPM_COUNT_REQ, UPM_COUNT_CNF and associated imported types.</Comment>
24 </DocHistory>
25 <DocHistory>
26 <DocVersion Number="003" Year="04"/>
27 <Date Day="19" Month="1" Year="2004"/>
28 <Author>MVJ</Author>
29 <DocStatus State="APPROVED"/>
30 <Comment>Updated after review.</Comment>
31 </DocHistory>
32 <DocRef>
33 <RefId>[TI 8010.801]</RefId>
34 <RefTitle>8010.801, "References and Abbreviations (UMTS)", Texas InstrumentsTable of Contents1 Introduction 52 Constants 63 Primitives 73.1 UPM_DTI_REQ 73.2 UPM_DTI_CNF 73.3 UPM_COUNT_REQ 73.4 UPM_COUNT_CNF 84 Parameters 94.1 Imports from Common Include Documents 9</RefTitle>
35 </DocRef>
36 </DocInfoSection>
37 <PragmasSection>
38 <Description>
39 <Section>This section contains all pragmas that are defined for the 8010_157_UPM_SAP SAP</Section>
40 </Description>
41 <Pragma>
42 <Name>PREFIX</Name>
43 <Value ValueType="ALPHA">UPM</Value>
44 <Comment>Prefix for this document</Comment>
45 </Pragma>
46 <Pragma>
47 <Name>ALLWAYS_ENUM_IN_VAL_FILE</Name>
48 <Value ValueType="ALPHA">YES</Value>
49 <Comment>Enumeration values in value file</Comment>
50 </Pragma>
51 <Pragma>
52 <Name>ENABLE_GROUP</Name>
53 <Value ValueType="ALPHA">NO</Value>
54 <Comment>Enable h-file grouping</Comment>
55 </Pragma>
56 <Pragma>
57 <Name>COMPATIBILITY_DEFINES</Name>
58 <Value ValueType="ALPHA">NO</Value>
59 <Comment>Compatible to the old #defines</Comment>
60 </Pragma>
61 <History>
62 <Date Day="7" Month="1" Year="2004"/>
63 <Author>MVJ</Author>
64 <Comment>Initial</Comment>
65 </History>
66 </PragmasSection>
67 <PrimitivesSection PrimIDType="BIT32" SAPid="157">
68 <Description>
69 <Section>The following sections describe the primitives defined on the UPM SAP.</Section>
70 </Description>
71 <Primitive>
72 <Description>
73 <Section>This primitive is used by ACI's DTI manager to order DTI connection establishment or termination from UPM.</Section>
74 </Description>
75 <PrimDef>
76 <Name>UPM_DTI_REQ</Name>
77 <PrimID Direction="UPLINK" Number="0"/>
78 <PrimUsage>
79 <Sender>ACI</Sender>
80 <Receiver>UPM</Receiver>
81 </PrimUsage>
82 </PrimDef>
83 <PrimItem Presentation="MANDATORY">
84 <ItemLink>
85 <DocName DocType="SAP">8010_137_nas_include</DocName>
86 <Name>nsapi</Name>
87 </ItemLink>
88 <Comment>Network layer service access point identifier</Comment>
89 </PrimItem>
90 <PrimItem Presentation="MANDATORY">
91 <ItemLink>
92 <DocName DocType="SAP">8010_137_nas_include</DocName>
93 <Name>dti_conn</Name>
94 </ItemLink>
95 <Comment>DTI connect</Comment>
96 </PrimItem>
97 <PrimItem Presentation="MANDATORY">
98 <ItemLink>
99 <DocName DocType="SAP">8010_137_nas_include</DocName>
100 <Name>dti_direction</Name>
101 </ItemLink>
102 <Comment>DTI direction</Comment>
103 </PrimItem>
104 <PrimItem Presentation="MANDATORY">
105 <ItemLink>
106 <DocName DocType="SAP">8010_137_nas_include</DocName>
107 <Name>dti_linkid</Name>
108 </ItemLink>
109 <Comment>DTI link ID</Comment>
110 </PrimItem>
111 <PrimItem Presentation="MANDATORY">
112 <ItemLink>
113 <DocName DocType="SAP">8010_137_nas_include</DocName>
114 <Name>dti_neighbor</Name>
115 </ItemLink>
116 <Comment>DTI neighbor</Comment>
117 </PrimItem>
118 <History>
119 <Date Day="7" Month="1" Year="2004"/>
120 <Author>MVJ</Author>
121 <Comment>Initial</Comment>
122 </History>
123 </Primitive>
124 <Primitive>
125 <Description>
126 <Section>This primitive is used by UPM to inform ACI's DTI manager that a previously ordered connection establishment/termination is complete.</Section>
127 </Description>
128 <PrimDef>
129 <Name>UPM_DTI_CNF</Name>
130 <PrimID Direction="DOWNLINK" Number="0"/>
131 <PrimUsage>
132 <Sender>UPM</Sender>
133 <Receiver>ACI</Receiver>
134 </PrimUsage>
135 </PrimDef>
136 <PrimItem Presentation="MANDATORY">
137 <ItemLink>
138 <DocName DocType="SAP">8010_137_nas_include</DocName>
139 <Name>dti_linkid</Name>
140 </ItemLink>
141 <Comment>DTI Link ID</Comment>
142 </PrimItem>
143 <PrimItem Presentation="MANDATORY">
144 <ItemLink>
145 <DocName DocType="SAP">8010_137_nas_include</DocName>
146 <Name>dti_conn</Name>
147 </ItemLink>
148 <Comment>DTI connect</Comment>
149 </PrimItem>
150 <History>
151 <Date Day="7" Month="1" Year="2004"/>
152 <Author>MVJ</Author>
153 <Comment>Initial</Comment>
154 </History>
155 </Primitive>
156 <Primitive>
157 <Description>
158 <Section>This primitive is used to get information about the amount of transferred data. Parameter 'nsapi' indicates the affected nsapi. If parameter 'reset' is set to NAS_RESET, then the last values of all counters will be sent with the resulting UPM_COUNT_CNF and all counters for the affected nsapi will be set to 0. If parameter 'reset' is set to NAS_NO_RESET then then the last values of all counters will be sent with the resulting UPM_COUNT_CNF.</Section>
159 </Description>
160 <PrimDef>
161 <Name>UPM_COUNT_REQ</Name>
162 <PrimID Direction="UPLINK" Number="1"/>
163 <PrimUsage>
164 <Sender>ACI</Sender>
165 <Receiver>UPM</Receiver>
166 </PrimUsage>
167 </PrimDef>
168 <PrimItem Presentation="MANDATORY">
169 <ItemLink>
170 <DocName DocType="SAP">8010_137_nas_include</DocName>
171 <Name>nsapi</Name>
172 </ItemLink>
173 <Comment>network layer service access point identifier</Comment>
174 </PrimItem>
175 <PrimItem Presentation="MANDATORY">
176 <ItemLink>
177 <DocName DocType="SAP">8010_137_nas_include</DocName>
178 <Name>reset</Name>
179 </ItemLink>
180 <Comment>shall counters be reset</Comment>
181 </PrimItem>
182 <History>
183 <Date Day="8" Month="1" Year="2004"/>
184 <Author>MVJ</Author>
185 <Comment>Initial.</Comment>
186 </History>
187 </Primitive>
188 <Primitive>
189 <Description>
190 <Section>This primitive is used to get information about the amount of transferred data. Parameter 'nsapi' indicates the affected nsapi. Parameter 'octets_uplink' indicates the number of transferred octets uplink. Only payload without layer 2 headers is computed. Parameter 'octets_downlink' indicates the number of transferred octets downlink. Parameter 'packets_uplink' indicates the number of transferred packets uplink. Parameter 'packets_downlink' indicates the number of transferred packets downlink.</Section>
191 </Description>
192 <PrimDef>
193 <Name>UPM_COUNT_CNF</Name>
194 <PrimID Direction="DOWNLINK" Number="1"/>
195 <PrimUsage>
196 <Sender>UPM</Sender>
197 <Receiver>ACI</Receiver>
198 </PrimUsage>
199 </PrimDef>
200 <PrimItem Presentation="MANDATORY">
201 <ItemLink>
202 <DocName DocType="SAP">8010_137_nas_include</DocName>
203 <Name>nsapi</Name>
204 </ItemLink>
205 <Comment>network layer service access point identifier</Comment>
206 </PrimItem>
207 <PrimItem Presentation="MANDATORY">
208 <ItemLink>
209 <DocName DocType="SAP">8010_137_nas_include</DocName>
210 <Name>octets_uplink</Name>
211 </ItemLink>
212 <Comment>octets uplink</Comment>
213 </PrimItem>
214 <PrimItem Presentation="MANDATORY">
215 <ItemLink>
216 <DocName DocType="SAP">8010_137_nas_include</DocName>
217 <Name>octets_downlink</Name>
218 </ItemLink>
219 <Comment>octets downlink</Comment>
220 </PrimItem>
221 <PrimItem Presentation="MANDATORY">
222 <ItemLink>
223 <DocName DocType="SAP">8010_137_nas_include</DocName>
224 <Name>packets_uplink</Name>
225 </ItemLink>
226 <Comment>packets uplink</Comment>
227 </PrimItem>
228 <PrimItem Presentation="MANDATORY">
229 <ItemLink>
230 <DocName DocType="SAP">8010_137_nas_include</DocName>
231 <Name>packets_downlink</Name>
232 </ItemLink>
233 <Comment>packets downlink</Comment>
234 </PrimItem>
235 <History>
236 <Date Day="8" Month="1" Year="2004"/>
237 <Author>MVJ</Author>
238 <Comment>Initial.</Comment>
239 </History>
240 </Primitive>
241 </PrimitivesSection>
242 </SAP>