Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_capability_licensing.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2020-2021 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 ***********************************************************************
26 *
27 * @filename openapi_capability_licensing.h
28 *
29 * @purpose Capability Lisensing feature
30 *
31 * @component OPEN
32 *
33 * @create 03/31/2020
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_CAPABILITY_LICENSING_H_INCLUDED
39 #define OPENAPI_CAPABILITY_LICENSING_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_CAPAB_LIC_MAX_LICENSE_FILES 16
44 #define OPEN_CAPAB_LIC_MAX_VER_LEN 6
45 #define OPEN_CAPAB_LIC_MAX_KEY_LEN 32
46 #define OPEN_CAPAB_LIC_MAX_MODEL_LEN 32
47 #define OPEN_CAPAB_LIC_MAX_SERIAL_LEN 64
48 #define OPEN_CAPAB_LIC_MAX_FILE_PARAM_VAL_LEN 64
49 
50 /* License status code */
51 typedef enum
52 {
53  OPEN_CAPAB_LICENSE_STATUS_FILE_NOT_PRESENT = 1,
54  OPEN_CAPAB_LICENSE_STATUS_VALID,
55  OPEN_CAPAB_LICENSE_STATUS_APPLIED,
56  OPEN_CAPAB_LICENSE_STATUS_REMOVED,
57  OPEN_CAPAB_LICENSE_STATUS_INVALID,
58  OPEN_CAPAB_LICENSE_STATUS_UNSUPPORTED,
59  OPEN_CAPAB_LICENSE_STATUS_DUPLICATE,
60  OPEN_CAPAB_LICENSE_STATUS_ERROR,
61 } OPEN_CAPAB_LICENSE_STATUS_TYPE_t;
62 
63 /* License type */
64 typedef enum
65 {
66  OPEN_CAPAB_LICENSE_TYPE_UNKNOWN = 1,
67  OPEN_CAPAB_LICENSE_TYPE_PORT,
68  OPEN_CAPAB_LICENSE_TYPE_FEATURE,
69  OPEN_CAPAB_LICENSE_TYPE_PORT_FEATURE,
70 } OPEN_CAPAB_LICENSE_TYPE_t;
71 
72 typedef enum
73 {
74  OPEN_CAPAB_LICENSE_FILE_PARAM_COPY = 1,
75  OPEN_CAPAB_LICENSE_FILE_PARAM_DATE,
76  OPEN_CAPAB_LICENSE_FILE_PARAM_DESC,
77 } OPEN_CAPAB_LICENSE_FILE_PARAM_TYPE_t;
78 
79 
80 /*************************************************************************/
95 open_error_t openapiCapabLicenseCountGet(openapiClientHandle_t *client_handle,
96  uint32_t *numOfLicenses);
97 
98 /*************************************************************************/
113 open_error_t openapiCapabLicenseFirstIndexGet(openapiClientHandle_t *client_handle,
114  uint32_t *firstLicenseIndex);
115 
116 /*************************************************************************/
132 open_error_t openapiCapabLicenseNextIndexGet(openapiClientHandle_t *client_handle,
133  uint32_t currentIndex,
134  uint32_t *nextLicenseIndex);
135 
136 /*************************************************************************/
152 open_error_t openapiCapabLicenseTypeGet(openapiClientHandle_t *client_handle,
153  uint32_t licenseIndex,
154  OPEN_CAPAB_LICENSE_TYPE_t *type);
155 
156 /*************************************************************************/
172 open_error_t openapiCapabLicenseStatusGet(openapiClientHandle_t *client_handle,
173  uint32_t licenseIndex,
174  OPEN_CAPAB_LICENSE_STATUS_TYPE_t *status);
175 
176 /*************************************************************************/
193 open_error_t openapiCapabLicenseParamGet(openapiClientHandle_t *client_handle,
194  uint32_t licenseIndex,
195  OPEN_CAPAB_LICENSE_FILE_PARAM_TYPE_t paramType,
196  open_buffdesc *paramValue);
197 
198 /*************************************************************************/
214 open_error_t openapiCapabLicenseVersionGet(openapiClientHandle_t *client_handle,
215  uint32_t licenseIndex,
216  open_buffdesc *version);
217 
218 /*************************************************************************/
234 open_error_t openapiCapabLicenseKeyGet(openapiClientHandle_t *client_handle,
235  uint32_t licenseIndex,
236  open_buffdesc *version);
237 
238 /*************************************************************************/
254 open_error_t openapiCapabLicenseModelGet(openapiClientHandle_t *client_handle,
255  uint32_t licenseIndex,
256  open_buffdesc *model);
257 
258 /*************************************************************************/
274 open_error_t openapiCapabLicenseSerialNumberGet(openapiClientHandle_t *client_handle,
275  uint32_t licenseIndex,
276  open_buffdesc *serialNum);
277 
278 
279 /*************************************************************************/
294 open_error_t openapiCapabLicenseLicenseRemove(openapiClientHandle_t *client_handle,
295  uint32_t licenseIndex);
296 
297 /*************************************************************************/
311 open_error_t openapiCapabLicenseLicenseRemoveAll(openapiClientHandle_t *client_handle);
312 
313 #endif /* OPENAPI_CAPABILITY_LICENSING_H_INCLUDED */
314