sysMgr.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 sysMgr.h
*
* @brief IARM-Bus Sys Manager Public API.
*/
 
/**
 * @defgroup IARMBUS_SYS_MGR Sys Manager
 * @ingroup IARM_MGR
 *
 * Sys Manager is a IARM Manager application which maintains the state of different
 * subsystem/components of RDK such as HDMI, Network, RF, Date & Time, Tuner, CA, Mfr information etc.
 * It collects the State change and error codes through a common event handler.
 * It publishes RPC methods for getting the system state data.
 *
 * @par Following event handler is registered for receiving events from different components.
 * - @b IARM_BUS_SYSMGR_EVENT_SYSTEMSTATE
 * @par The Event Data contains
 * @code
 * IARM_Bus_SYSMgr_EventData_t *sysEventData; // The event data contains stateId, state and error.
 * @endcode
 *
 * @par Sys Manager: Events
 *
 * - @b IARM_BUS_SYSMGR_EVENT_HDCP_PROFILE_UPDATE
 * Event to notify HDCP Profile change:
 *
 * @par Sys Manager: RPC Methods
 * Following RPC Methods are published:
 *
 *
 * - @b IARM_BUS_SYSMGR_API_GetSystemStates
 * @n This returns the System State data structure.
 * @n Example:
 * @code
 * IARM_Bus_RegisterCall(IARM_BUS_SYSMGR_API_GetSystemStates, _GetSystemStates);
 * @endcode
 *
 * - @b IARM_BUS_SYSMGR_API_SetHDCPProfile
 * @n This Method is called to set the new HDCP Profile.
 * @n Example:
 * @code
 * IARM_Bus_RegisterCall(IARM_BUS_SYSMGR_API_SetHDCPProfile,_SetHDCPProfile);
 * @endcode
 *
 * - @b IARM_BUS_SYSMGR_API_GetHDCPProfile
 * @n This Method is called to get the current HDCP Profile.
 * @n Example:
 * @code
 * IARM_Bus_RegisterCall(IARM_BUS_SYSMGR_API_GetHDCPProfile,_GetHDCPProfile);
 * @endcode
 *
 * - @b IARM_BUS_SYSMGR_API_RunScript
 * @n This Method is called to run a script through Sys Manager.
 * @n Example:
 * @code
 * IARM_Bus_RegisterCall(IARM_BUS_SYSMGR_API_RunScript, _RunScript);
 * @endcode
 
 */
 
 
/**
* @defgroup iarmmgrs
* @{
* @defgroup sysmgr
* @{
**/
 
 
 
 
/**
* @defgroup iarmmgrs
* @{
* @defgroup sysmgr
* @{
**/
 
 
#ifndef _IARM_BUS_SYSMGR_H
#define _IARM_BUS_SYSMGR_H
 
#include "libIARM.h"
 
#ifdef __cplusplus
extern "C" 
{
#endif
 
#define IARM_BUS_SYSMGR_NAME                                        "SYSMgr" /*!< IARM BUS  name for Sys manager */
 
 
typedef struct _IARM_BUS_SYSMGR_GetXUPNPDeviceInfo_Param_t{
    char *pBuffer;                                   /*!< Shared memory location having expected data*/
    int bufLength;                                      /*!< Length of buffer */
}IARM_Bus_SYSMGR_GetXUPNPDeviceInfo_Param_t;
 
 
typedef struct _IARM_BUS_SYSMGR_HDCPProfileInfo_Param_t{
      int HdcpProfile;                                      /*!< HDCP Profile Data */
}IARM_BUS_SYSMGR_HDCPProfileInfo_Param_t;
 
typedef struct _IARM_BUS_SYSMGR_KEYCodeLoggingInfo_Param_t{
      int logStatus;                                      /*!< HDCP Profile Data */
}IARM_BUS_SYSMGR_KEYCodeLoggingInfo_Param_t;
 
/*! Published Events from sys manager  */
typedef enum _SYSMgr_EventId_t {
    IARM_BUS_SYSMGR_EVENT_SYSTEMSTATE,
        IARM_BUS_SYSMGR_EVENT_XUPNP_DATA_REQUEST,               /*!< Xupnp data  request frm Receiver to UPNP*/ 
        IARM_BUS_SYSMGR_EVENT_XUPNP_DATA_UPDATE,    /*!< Xupnp data  frm  UPNP to  Receiver*/
        IARM_BUS_SYSMGR_EVENT_IMAGE_DNLD,   /*Image download status to Receiver   */  
        IARM_BUS_SYSMGR_EVENT_CARD_FWDNLD,              /*!< CARD FW download event to Receiver - Valid on Cisco CA*/ 
        IARM_BUS_SYSMGR_EVENT_HDCP_PROFILE_UPDATE,      /*!< HDCP Profile Update */ 
        IARM_BUS_SYSMGR_EVENT_INTRUSION,                /*!< Intrusion Detection */ 
        IARM_BUS_SYSMGR_EVENT_EISS_FILTER_STATUS,       /*!< EISS Filter status event */
        IARM_BUS_SYSMGR_EVENT_EISS_APP_ID_UPDATE,       /*!< EISS App ID update */
        IARM_BUS_SYSMGR_EVENT_KEYCODE_LOGGING_CHANGED,  /*!< Key Code logging status update */
        IARM_BUS_SYSMGR_EVENT_USB_MOUNT_CHANGED,        /*!< Fires when USB mounts change */
        IARM_BUS_SYSMGR_EVENT_APP_RELEASE_FOCUS,        /*!< Application fires event to release focus*/
        IARM_BUS_SYSMGR_EVENT_MAX                               /*!< Max Event Id */
} IARM_Bus_SYSMgr_EventId_t;
 
typedef enum _SYSMgr_SystemState_t {
  IARM_BUS_SYSMGR_SYSSTATE_CHANNELMAP, //0
  IARM_BUS_SYSMGR_SYSSTATE_DISCONNECTMGR,//1
  IARM_BUS_SYSMGR_SYSSTATE_TUNEREADY, //2
  IARM_BUS_SYSMGR_SYSSTATE_EXIT_OK,//3
  IARM_BUS_SYSMGR_SYSSTATE_CMAC,//4
  IARM_BUS_SYSMGR_SYSSTATE_MOTO_ENTITLEMENT,//5
  IARM_BUS_SYSMGR_SYSSTATE_MOTO_HRV_RX,//6
  IARM_BUS_SYSMGR_SYSSTATE_CARD_CISCO_STATUS,//7
  IARM_BUS_SYSMGR_SYSSTATE_VIDEO_PRESENTING,//8
  IARM_BUS_SYSMGR_SYSSTATE_HDMI_OUT,//9
  IARM_BUS_SYSMGR_SYSSTATE_HDCP_ENABLED,//10
  IARM_BUS_SYSMGR_SYSSTATE_HDMI_EDID_READ,//11
  IARM_BUS_SYSMGR_SYSSTATE_FIRMWARE_DWNLD,//12
  IARM_BUS_SYSMGR_SYSSTATE_TIME_SOURCE,//13
  IARM_BUS_SYSMGR_SYSSTATE_TIME_ZONE,//14
  IARM_BUS_SYSMGR_SYSSTATE_CA_SYSTEM,//15
  IARM_BUS_SYSMGR_SYSSTATE_ESTB_IP,//16
  IARM_BUS_SYSMGR_SYSSTATE_ECM_IP,//17
  IARM_BUS_SYSMGR_SYSSTATE_LAN_IP,//18
  IARM_BUS_SYSMGR_SYSSTATE_MOCA,//19
  IARM_BUS_SYSMGR_SYSSTATE_DOCSIS,//20
  IARM_BUS_SYSMGR_SYSSTATE_DSG_BROADCAST_CHANNEL,//21
  IARM_BUS_SYSMGR_SYSSTATE_DSG_CA_TUNNEL,//22
  IARM_BUS_SYSMGR_SYSSTATE_CABLE_CARD,//23
  IARM_BUS_SYSMGR_SYSSTATE_CABLE_CARD_DWNLD,//24
  IARM_BUS_SYSMGR_SYSSTATE_CVR_SUBSYSTEM,//25
  IARM_BUS_SYSMGR_SYSSTATE_DOWNLOAD,//26
  IARM_BUS_SYSMGR_SYSSTATE_VOD_AD,//27
  IARM_BUS_SYSMGR_SYSSTATE_DAC_INIT_TIMESTAMP,//28
  IARM_BUS_SYSMGR_SYSSTATE_CABLE_CARD_SERIAL_NO,//29
  IARM_BUS_SYSMGR_SYSSTATE_ECM_MAC,//30
  IARM_BUS_SYSMGR_SYSSTATE_DAC_ID,//31   
  IARM_BUS_SYSMGR_SYSSTATE_PLANT_ID,//32  
  IARM_BUS_SYSMGR_SYSSTATE_STB_SERIAL_NO, //33   
  IARM_BUS_SYSMGR_SYSSTATE_BOOTUP, //34
  IARM_BUS_SYSMGR_SYSSTATE_GATEWAY_CONNECTION, //35  
  IARM_BUS_SYSMGR_SYSSTATE_DST_OFFSET, //36
  IARM_BUS_SYSMGR_SYSSTATE_RF_CONNECTED, //37
  IARM_BUS_SYSMGR_SYSSTATE_PARTNERID_CHANGE, //38
  IARM_BUS_SYSMGR_SYSSTATE_IP_MODE, //39
  IARM_BUS_SYSMGR_SYSSTATE_LP_CONNECTION_RESET, //40
  IARM_BUS_SYSMGR_SYSSTATE_RWS_CONNECTION_RESET, //41
  IARM_BUS_SYSMGR_SYSSTATE_QAM_READY, //42
  IARM_BUS_SYSMGR_SYSSTATE_FIRMWARE_UPDATE_STATE, //43, Added as part of RDK-19978, As the IARM 
                                                 // requirement for RDK-19978 and IARM_BUS_SYSMGR_SYSSTATE_FIRMWARE_DWNLD 
                                                 // are having some mismatches, introduced the new event
  IARM_BUS_SYSMGR_SYSSTATE_USB_DETECTED //44
}IARM_Bus_SYSMgr_SystemState_t;
 
 
/*! Possible Firmware Download state */
typedef enum _SYSMgr_CARD_FWDNLDState_t
{
  IARM_BUS_SYSMGR_CARD_FWDNLD_START,
  IARM_BUS_SYSMGR_CARD_FWDNLD_COMPLETE,
} IARM_Bus_SYSMGR_FWDNLDState_t;
 
/*! Possible Image Download state */
typedef enum _SYSMgr_IMAGE_FWDNLDState_t
{
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_UNINITIALIZED,
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_DOWNLOAD_INPROGRESS,
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_DOWNLOAD_COMPLETE,
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_DOWNLOAD_FAILED,
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_FLASH_INPROGRESS,
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_FLASH_COMPLETE,
  IARM_BUS_SYSMGR_IMAGE_FWDNLD_FLASH_FAILED
} IARM_Bus_SYSMGR_IMG_FWDNLDState_t;
 
/*! Possible Firmware Update States (as per RDK-14100, RDK-19928)*/
typedef enum _SYSMgr_FirmwareUpdateState_t
{
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_UNINITIALIZED = 0,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_REQUESTING = 1,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_DOWNLOADING = 2,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_FAILED = 3,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_DOWNLOAD_COMPLETE = 4,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_VALIDATION_COMPLETE = 5,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_PREPARING_TO_REBOOT = 6,
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_ONHOLD_FOR_OPTOUT = 7, /* On Hold for opt-out */
  IARM_BUS_SYSMGR_FIRMWARE_UPDATE_STATE_CRITICAL_REBOOT = 8
} IARM_Bus_SYSMGR_FirmwareUpdateState_t;
 
/*! Event Data associated with Sys Managers */ 
typedef struct _IARM_BUS_SYSMgr_EventData_t{
        union {
                struct _CARD_FWDNLD_DATA {
                        char eventType;
                        char status;
                } cardFWDNLD;
                struct _IMAGE_FWDNLD_DATA {
                        char status;
                } imageFWDNLD;
                struct _XUPNP_DATA {
                        unsigned long deviceInfoLength;
                } xupnpData;
                struct _HDCP_PROFILE {
                        unsigned int hdcpProfile;
                } hdcpProfileData;
                struct _SystemStates {
                        IARM_Bus_SYSMgr_SystemState_t stateId;
                        int state;
                        int error;
                        char payload[128];
                } systemStates;
                struct _EISS_STATUS {
                        int filterStatus;
                } eissEventData;
                struct _EISS_APP_ID {
                        unsigned char idList[4][6];
                        int count;
                } eissAppIDList;
                struct _KEY_CODE_LOG {
                        int logStatus;
                } keyCodeLogData;
                struct _USB_MOUNT {
                        int mounted;
                        char device[128];
                        char dir[256];
                } usbMountData;
                struct _USB_DETECT {
                        int inserted;
                        char vendor[128];
                        char productid[256];
                        char devicename[256];
                } usbData;
 
        } data;
}IARM_Bus_SYSMgr_EventData_t;
 
typedef struct _propertyValue
{
  int state;
  int error;
  char payload[128];
} state_property;
/*
 * Declare RPC API names and their arguments
 */
#define IARM_BUS_SYSMGR_API_GetSystemStates     "GetSystemStates" /*!< Gets the states of the system*/
 
/*
 * Declare RPC API names for HDCP Profile
 */
#define IARM_BUS_SYSMGR_API_SetHDCPProfile      "SetHDCPProfile"
#define IARM_BUS_SYSMGR_API_GetHDCPProfile      "GetHDCPProfile"
 
/*
 * Declare RPC API names for Key Code Logging Status
 */
#define IARM_BUS_SYSMGR_API_GetKeyCodeLoggingPref "GetKeyCodeLoggingPref"
#define IARM_BUS_SYSMGR_API_SetKeyCodeLoggingPref "SetKeyCodeLoggingPref"
 
/*! Parameter for Setpowerstate call*/
typedef struct _IARM_Bus_SYSMgr_GetSystemStates_Param_t {
        state_property channel_map;        /*!< [in] New powerstate to be set */
  state_property disconnect_mgr_state;
  state_property TuneReadyStatus;
  state_property exit_ok_key_sequence;
  state_property cmac;
  state_property card_moto_entitlements;
  state_property card_moto_hrv_rx;
  state_property dac_init_timestamp;
  state_property card_cisco_status;
  state_property video_presenting;
  state_property hdmi_out;
  state_property hdcp_enabled;
  state_property hdmi_edid_read;
  state_property firmware_download;
  state_property time_source;
  state_property time_zone_available;
  state_property ca_system;
  state_property estb_ip;
  state_property ecm_ip;
  state_property lan_ip;
  state_property moca;
  state_property docsis;
  state_property dsg_broadcast_tunnel;
  state_property dsg_ca_tunnel;
  state_property cable_card;
  state_property cable_card_download;
  state_property cvr_subsystem;
  state_property download;
  state_property vod_ad;
  state_property card_serial_no;
  state_property ecm_mac;
  state_property dac_id;
  state_property plant_id;
  state_property stb_serial_no;
  state_property bootup;
  state_property dst_offset;
  state_property rf_connected;
  state_property ip_mode;  
  state_property qam_ready_status;
  state_property firmware_update_state;
} IARM_Bus_SYSMgr_GetSystemStates_Param_t;
 
#define IARM_BUS_SYSMGR_Intrusion_MaxLen 1024
 
/*! Parameter for intrusion detect call*/
typedef struct _IARM_Bus_SYSMgr_IntrusionData_t{
    char intrusionData[ IARM_BUS_SYSMGR_Intrusion_MaxLen+1 ];   //[in]  intrusion detection data
} IARM_Bus_SYSMgr_IntrusionData_t;
 
 
#ifdef __cplusplus
}
#endif
 
#endif
 
/* End of IARM_BUS_SYSMGR_API doxygen group */
/**
 * @}
 */
 
 
 
/** @} */
/** @} */