Service_Storage_PhyMedium.h

Go to the documentation of this file.

/*
 * If not stated otherwise in this file or this component's Licenses.txt file the
 * following copyright and licenses apply:
 *
 * Copyright 2016 RDK Management
 *
 * 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.
*/
 
/**
 * @file Service_Storage_PhyMedium.h
 * @brief The header file provides storage service physical medium information APIs.
 */
 
/**
 * @defgroup TR69_HOSTIF_STORAGE_PHYSICALMEDIUM TR-069 Object (Device.StorageService.PhysicalMedium.Interface)
 * This object provides information about each physical medium connected to this device.
 * At most one entry in this table can exist with a given value for Name, or with all the
 * same values for Vendor, Model and SerialNumber, or with a given value for Alias.
 *
 * @note Alias
 * is a non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to
 * label this instance for future reference.
 *
 * If the CPE supports the Alias-based Addressing feature the following mandatory constraints MUST be enforced:
 * - Its value MUST NOT be empty.
 * - Its value MUST start with a letter.
 * If its value is not assigned by the ACS, it MUST start with a 'cpe-' prefix.
 * The CPE MUST NOT change the parameter value.
 * @ingroup TR69_HOSTIF_STORAGE
 *
 * @defgroup TR69_HOSTIF_STORAGE_PHYSICALMEDIUM_API TR-069 Object (Device.StorageService.PhysicalMedium.Interface.{i}) Public APIs
 * Describe the details about RDK TR069 storage service  physical medium  APIs specifications.
 * @ingroup TR69_HOSTIF_STORAGE_PHYSICALMEDIUM
 *
 * @defgroup TR69_HOSTIF_STORAGE_PHYSICALMEDIUM_CLASSES TR-069 Object (Device.StorageService.PhysicalMedium.Interface.{i}) Public Classes
 * Describe the details about classes used in TR-069 storage service  physical medium.
 * @ingroup TR69_HOSTIF_STORAGE_PHYSICALMEDIUM
 */
#ifndef _SERVICE_STORAGE_PHYMED_H_
#define _SERVICE_STORAGE_PHYMED_H_
#include "hostIf_main.h"
#include "hostIf_tr69ReqHandler.h"
#include "hostIf_utils.h"
#include "hostIf_updateHandler.h"
#define MAX_PHY_MED_ALIAS_LEN 64
#define MAX_PHY_MED_NAME_LEN 64
#define MAX_PHY_MED_VENDOR_LEN 64
#define MAX_PHY_MED_MODEL_LEN 128
#define MAX_PHY_MED_SERIAL_NUM_LEN 64
#define MAX_PHY_MED_FIRMWARE_VER_LEN 64
#define MAX_PHY_MED_CONNECTION_TYPE_LEN 64
#define MAX_PHY_MED_STATUS_LEN 64
#define MAX_PHY_MED_HEALTH_LEN 64
 
/**
 * @struct physicalMediumMembers
 * @brief It contains the members variables of the physicalMediumMembers structure.
 */
typedef struct physicalMediumMembers
{
    char alias[MAX_PHY_MED_ALIAS_LEN];
    char name[MAX_PHY_MED_NAME_LEN];
    char vendor[MAX_PHY_MED_VENDOR_LEN];
    char model[MAX_PHY_MED_MODEL_LEN];
    char serialNumber[MAX_PHY_MED_SERIAL_NUM_LEN];
    char firmwareVersion[MAX_PHY_MED_FIRMWARE_VER_LEN];
    char connectionType[MAX_PHY_MED_CONNECTION_TYPE_LEN];
    bool removable;
    unsigned int capacity;
    char status[MAX_PHY_MED_STATUS_LEN];
    unsigned int uptime;
    bool smartCapable;
    char health[MAX_PHY_MED_HEALTH_LEN];
    bool hotSwappable;
}PhysicalMediumMembers_t;
 
/**
 * @enum ePhysicalMediumMembers_t
 * @brief It contains the members variables of the ePhysicalMediumMembers_t enum.
 */
typedef enum 
{
    eAlias,
    eName,
    eVendor,
    eModel,
    eSerialNumber,
    eFirmwareVersion,
    eConnectionType,
    eRemovable,
    eCapacity,
    eStatus,
    eUptime,
    eSmartCapable,
    eHealth,
    eHotSwappable
}ePhysicalMediumMembers_t;
 
/**
 * @brief This class provides the TR-069 host interface physical medium information.
 * @ingroup TR69_HOSTIF_STORAGE_PHYSICALMEDIUM_CLASSES
 */
class hostIf_PhysicalMedium
{
    
    static  GHashTable  *phyMedHash;
 
    static GMutex *m_mutex;
 
    int dev_id;
 
    static PhysicalMediumMembers_t physicalMediumMembers;
 
    int get_StorageService_PhyMed_Fields(ePhysicalMediumMembers_t phyMedMember);
 
    hostIf_PhysicalMedium(int StorageServiceInstanceNumber, int dev_id);
    
    int getMediumName(char* mediumName);
    
    bool isSmartCapable();
 
    int isMediumHealthOK();
 
    static int rebuildHash();
 
    static int getPhysicalMediumNumberOfEntries(int storageServiceInstanceNumber);
 
    int storageServiceInstanceNumber;
 
    public:
        
        static hostIf_PhysicalMedium* getInstance(int storageService, int dev_id);
 
        static void closeInstance(hostIf_PhysicalMedium*);
 
        static GList* getAllInstances();
 
        static void closeAllInstances();
 
        static int get_Device_Service_StorageMedium_ClientNumberOfEntries(HOSTIF_MsgData_t *stMsgData, int dev_id);
 
        static int updateCallbackFunction(updateCallback cb);
 
        int get_Device_Service_StorageMedium_Alias(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Name(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Vendor(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Model(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_SerialNumber(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_FirmwareVersion(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_ConnectionType(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Removable(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Status(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Uptime(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_SMARTCapable(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_Health(HOSTIF_MsgData_t *stMsgData);
 
        int get_Device_Service_StorageMedium_HotSwappable(HOSTIF_MsgData_t *stMsgData);
 
        void getLock();
 
        void releaseLock();
};
#endif