Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_ets.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2017-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 * Licensed under the Apache License, Version 2.0 (the "License");
26 * you may not use this file except in compliance with the License.
27 * You may obtain a copy of the License at
28 *
29 * http://www.apache.org/licenses/LICENSE-2.0
30 *
31 * Unless required by applicable law or agreed to in writing, software
32 * distributed under the License is distributed on an "AS IS" BASIS,
33 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34 * See the License for the specific language governing permissions and
35 * limitations under the License.
36 *
37 **********************************************************************
38 *
39 * @filename openapi_ets.h
40 *
41 * @purpose Enhanced Transmission Session APIs.
42 *
43 * @component OPEN
44 *
45 * @create 01/23/2017
46 *
47 * @end
48 *
49 **********************************************************************/
50 #ifndef OPENAPI_ETS_H_INCLUDED
51 #define OPENAPI_ETS_H_INCLUDED
52 
53 #include "openapi_common.h"
54 
55 #define OPEN_DOT1P_MIN_PRIORITY 0
56 #define OPEN_DOT1P_MAX_PRIORITY 7
57 
58 #define OPEN_ETS_TCG_NUM_MIN 0
59 #define OPEN_ETS_TCG_NUM_MAX 7
60 
61 #define OPEN_ETS_BW_PERCENTAGE_MIN 1
62 #define OPEN_ETS_BW_PERCENTAGE_MAX 100
63 
64 /*****************************************************************/
78 open_error_t openapiEtsPeerIncompatibleCfgCountGet(openapiClientHandle_t *client_handle,
79  uint32_t ifNum,
80  uint32_t *incompatibleCfgCount);
81 
82 /*****************************************************************/
99 open_error_t openapiEtsPeerNumTcGet(openapiClientHandle_t *client_handle,
100  uint32_t ifNum,
101  uint32_t priority,
102  uint8_t *numTc);
103 
104 /*****************************************************************/
119 open_error_t openapiEtsPeerWillingGet(openapiClientHandle_t *client_handle,
120  uint32_t ifNum,
121  OPEN_BOOL_t *willing);
122 
123 /*****************************************************************/
137 open_error_t openapiEtsPeerCbsStatusGet(openapiClientHandle_t *client_handle,
138  uint32_t ifNum,
139  OPEN_BOOL_t *cbsStatus);
140 
141 /*****************************************************************/
159 open_error_t openapiEtsPeerMinBandwidthGet(openapiClientHandle_t *client_handle,
160  uint32_t ifNum,
161  uint32_t tcg,
162  uint8_t *bw);
163 
164 /*****************************************************************/
181 open_error_t openapiEtsPeerTsaGet(openapiClientHandle_t *client_handle,
182  uint32_t ifNum,
183  uint32_t tcg,
184  uint8_t *sched);
185 
186 #endif /* OPENAPI_ETS_H_INCLUDED */
187