openapi_capability_licensing.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2020-2021 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_capability_licensing.h
*
* @purpose   Capability Lisensing feature
*
* @component OPEN
*
* @create    03/31/2020
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_CAPABILITY_LICENSING_H_INCLUDED
#define OPENAPI_CAPABILITY_LICENSING_H_INCLUDED

#include "openapi_common.h" 

#define OPEN_CAPAB_LIC_MAX_LICENSE_FILES      16
#define OPEN_CAPAB_LIC_MAX_VER_LEN            6
#define OPEN_CAPAB_LIC_MAX_KEY_LEN            32
#define OPEN_CAPAB_LIC_MAX_MODEL_LEN          32
#define OPEN_CAPAB_LIC_MAX_SERIAL_LEN         64
#define OPEN_CAPAB_LIC_MAX_FILE_PARAM_VAL_LEN    64

/* License status code */
typedef enum
{
  OPEN_CAPAB_LICENSE_STATUS_FILE_NOT_PRESENT = 1,  
  OPEN_CAPAB_LICENSE_STATUS_VALID,                 
  OPEN_CAPAB_LICENSE_STATUS_APPLIED,               
  OPEN_CAPAB_LICENSE_STATUS_REMOVED,               
  OPEN_CAPAB_LICENSE_STATUS_INVALID,               
  OPEN_CAPAB_LICENSE_STATUS_UNSUPPORTED,           
  OPEN_CAPAB_LICENSE_STATUS_DUPLICATE,             
  OPEN_CAPAB_LICENSE_STATUS_ERROR,                 
} OPEN_CAPAB_LICENSE_STATUS_TYPE_t;

/* License type */
typedef enum
{
  OPEN_CAPAB_LICENSE_TYPE_UNKNOWN = 1,
  OPEN_CAPAB_LICENSE_TYPE_PORT,         
  OPEN_CAPAB_LICENSE_TYPE_FEATURE,      
  OPEN_CAPAB_LICENSE_TYPE_PORT_FEATURE, 
} OPEN_CAPAB_LICENSE_TYPE_t;

typedef enum
{
  OPEN_CAPAB_LICENSE_FILE_PARAM_COPY = 1,  
  OPEN_CAPAB_LICENSE_FILE_PARAM_DATE,      
  OPEN_CAPAB_LICENSE_FILE_PARAM_DESC,      
} OPEN_CAPAB_LICENSE_FILE_PARAM_TYPE_t;


/*************************************************************************/
open_error_t openapiCapabLicenseCountGet(openapiClientHandle_t *client_handle, 
                                         uint32_t *numOfLicenses);

/*************************************************************************/
open_error_t openapiCapabLicenseFirstIndexGet(openapiClientHandle_t *client_handle, 
                                              uint32_t *firstLicenseIndex);

/*************************************************************************/
open_error_t openapiCapabLicenseNextIndexGet(openapiClientHandle_t *client_handle, 
                                             uint32_t currentIndex,
                                             uint32_t *nextLicenseIndex);

/*************************************************************************/
open_error_t openapiCapabLicenseTypeGet(openapiClientHandle_t *client_handle, 
                                        uint32_t  licenseIndex, 
                                        OPEN_CAPAB_LICENSE_TYPE_t *type);

/*************************************************************************/
open_error_t openapiCapabLicenseStatusGet(openapiClientHandle_t *client_handle, 
                                          uint32_t  licenseIndex, 
                                          OPEN_CAPAB_LICENSE_STATUS_TYPE_t *status);

/*************************************************************************/
open_error_t openapiCapabLicenseParamGet(openapiClientHandle_t *client_handle, 
                                         uint32_t  licenseIndex, 
                                         OPEN_CAPAB_LICENSE_FILE_PARAM_TYPE_t paramType, 
                                         open_buffdesc *paramValue);

/*************************************************************************/
open_error_t openapiCapabLicenseVersionGet(openapiClientHandle_t *client_handle, 
                                           uint32_t  licenseIndex, 
                                           open_buffdesc *version);

/*************************************************************************/
open_error_t openapiCapabLicenseKeyGet(openapiClientHandle_t *client_handle, 
                                       uint32_t  licenseIndex, 
                                       open_buffdesc *version);

/*************************************************************************/
open_error_t openapiCapabLicenseModelGet(openapiClientHandle_t *client_handle, 
                                         uint32_t  licenseIndex, 
                                         open_buffdesc *model);

/*************************************************************************/
open_error_t openapiCapabLicenseSerialNumberGet(openapiClientHandle_t *client_handle, 
                                                uint32_t  licenseIndex, 
                                                open_buffdesc *serialNum);


/*************************************************************************/
open_error_t openapiCapabLicenseLicenseRemove(openapiClientHandle_t *client_handle, 
                                              uint32_t  licenseIndex); 

/*************************************************************************/
open_error_t openapiCapabLicenseLicenseRemoveAll(openapiClientHandle_t *client_handle);

#endif /* OPENAPI_CAPABILITY_LICENSING_H_INCLUDED */