midware/CI/inc/ci_plus_control.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2010 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/

#ifndef CI_PLUS_CONTROL_H
#define CI_PLUS_CONTROL_H

/*---includes for this file--------------------------------------------------*/

/* compiler library header files */

/* third party header files */

/* DVBCore header files */
#include "techtype.h"
#include "stbhwc.h"
#include "stbci.h"
#include "stbsitab.h"

/*---Constant and macro definitions for public use-----------------------------*/


/* Screen type */
#define CIP_NO_CI_SCREEN            0
#define CIP_CI_MENU_LIST_SCREEN     1
#define CIP_CI_ENQUIRY_SCREEN       2

#define CIP_URI_LEN                 8

#define CIP_CICAM_ID_LEN            8

#define CIP_MAX_PIN_LENGTH          8

#define CIP_PIN_PRIVATE_DATA_SIZE   15


#define CIP_SERVICE_TYPE_TV         0x00000001   /* MPEG2 TV */
#define CIP_SERVICE_TYPE_RADIO      0x00000002   /* MPEG1 Layer-II radio */
#define CIP_SERVICE_TYPE_TELETEXT   0x00000004   /* Teletext */
#define CIP_SERVICE_TYPE_AVC_RADIO  0x00000008   /* AVC radio */
#define CIP_SERVICE_TYPE_DATA       0x00000010   /* Data */
#define CIP_SERVICE_TYPE_HD_TV      0x00000020   /* MPEG2 HD TV */
#define CIP_SERVICE_TYPE_AVC_SD_TV  0x00000040   /* AVC SD TV */
#define CIP_SERVICE_TYPE_AVC_HD_TV  0x00000080   /* AVC HD TV */

#define CIP_DELIVERY_TYPE_DVBT      0x0001
#define CIP_DELIVERY_TYPE_DVBT2     0x0002
#define CIP_DELIVERY_TYPE_DVBC      0x0004
#define CIP_DELIVERY_TYPE_DVBC2     0x0008
#define CIP_DELIVERY_TYPE_DVBS      0x0010
#define CIP_DELIVERY_TYPE_DVBS2     0x0020

#define CIP_APP_TYPE_MHEG           0x0001
#define CIP_APP_TYPE_HBBTV          0x0002
#define CIP_APP_TYPE_OIPF           0x0004

/* Replies for starting an operator profile search */
#define CIP_START_OPERATOR_SEARCH_NO    0x00
#define CIP_START_OPERATOR_SEARCH_YES   0x01
#define CIP_START_OPERATOR_SEARCH_ASK   0x02

/* Recording operating modes */
#define CIP_RECORD_MODE_WATCH_AND_BUFFER  0x00
#define CIP_RECORD_MODE_TIMESHIFT         0x01
#define CIP_RECORD_MODE_UNATTENDED        0x02

/* CICAM licence status */
#define CIP_LICENCE_STATUS_OK                         0x00
#define CIP_LICENCE_STATUS_NO_ENTITLEMENT             0x01
#define CIP_LICENCE_STATUS_UNDEFINED_ERROR            0x02
#define CIP_LICENCE_STATUS_RIGHTS_EXPIRED             0x03
#define CIP_LICENCE_STATUS_PLAY_COUNT_EXCEEDED        0x04
#define CIP_LICENCE_STATUS_RETENTION_LIMIT_EXCEEDED   0x05
#define CIP_LICENCE_STATUS_INVALID_LICENCE            0x06

/* Licence receive status */
#define CIP_LICENCE_RECEIVED_OK           0x00
#define CIP_LICENCE_RECEIVED_INVALID_DATA 0x01
#define CIP_LICENCE_RECEIVED_HOST_ERROR   0x02

/* Pin status values */
#define CIP_CAM_PIN_CODE_WRONG                0
#define CIP_CAM_PIN_CAM_BUSY                  1
#define CIP_CAM_PIN_CODE_CORRECT              2
#define CIP_CAM_PIN_CODE_UNCONFIRMED          3
#define CIP_CAM_PIN_NO_VIDEO_BLANK            4
#define CIP_CAM_PIN_CONTENT_STILL_SCRAMBLED   5

/*---Enumerations for public use-----------------------------------------------*/
typedef enum
{
   CIPLUS_GET_COUNTRY_CODE,
   CIPLUS_GET_LANGUAGE_CODE,
   CIPLUS_TUNE_TO_SERVICE,
   CIPLUS_TUNE_DEL_SYS_DESC,
   CIPLUS_CAM_UPGRADE_OPTION,
   CIPLUS_REQUEST_HOST_CONTROL,
   CIPLUS_RELEASE_HOST_CONTROL,
   CIPLUS_PROCESS_NIT,
   CIPLUS_REQUEST_HOST_INFO,
   CIPLUS_OPERATOR_TUNE,
   CIPLUS_REQUEST_OPERATOR_SEARCH,
   CIPLUS_OPERATOR_CAM_AVAILABLE,
   CIPLUS_OPERATOR_CAM_REMOVED,
   CIPLUS_GET_SUBTITLES_STARTED,
   CIPLUS_STOP_SUBTITLES,
   CIPLUS_START_SUBTITLES
} E_CI_QUERY;

typedef enum
{
   /* No module or unknown status */
   CIP_SLOT_STATUS_UNKNOWN = 0x0000,

   /* DVB-CI module is in the slot */
   CIP_SLOT_STATUS_MODULE_READY = 0x0001,

   /* CA descriptors were found in PMT */
   CIP_SLOT_STATUS_CA_USED = 0x0002,

   /* CA system is supported */
   CIP_SLOT_STATUS_CAS_SUPPORTED = 0x0004,

   /* Authenticated CI+ module is in the slot */
   CIP_SLOT_STATUS_CI_PLUS_MODULE = 0x0008,

   /* Transport stream is allowed to be routed through the module */
   CIP_SLOT_STATUS_SERVICE_ALLOWED = 0x0010
} E_CIP_SLOT_STATUS;

typedef enum
{
   CIP_TUNER_LOCKED,                /* Tuner has locked */
   CIP_TUNER_NOTLOCKED,             /* Tuner failed to lock */
   CIP_TUNER_BUSY,                  /* Tuner isn't available for use */
   CIP_TUNER_UNSUPPORTED_SYSTEM,    /* Tuner type isn't supported */
   CIP_TUNER_BAD_PARAM,             /* Tuning with invalid tuning parameter */
   CIP_TUNER_SERVICE_NOT_FOUND,     /* Tune to unknown service */
   CIP_TUNER_UNDEFINED_ERROR        /* Any other errors */
} E_CIP_TUNE_STATUS;

typedef enum
{
   CIP_OPERATOR_SEARCH_DEFERRED,
   CIP_OPERATOR_SEARCH_IMMEDIATE,
   CIP_OPERATOR_SEARCH_SCHEDULED
} E_CIP_OPERATOR_SEARCH_REQUEST_TYPE;

/*---Global type defs for public use-------------------------------------------*/
typedef struct ci_tune_service_info
{
   U16BIT nid; /* network id */
   U16BIT onid; /* original network id */
   U16BIT tsid; /* transport stream id */
   U16BIT sid;  /* service id */
} S_CIP_TUNE_SERVICE_INFO;

typedef struct ci_tune_del_sys_desc
{
   SI_DELIVERY_SYS_DESC_TYPE type;
   SI_DELIVERY_SYS_DESC *desc;
   U16BIT service_id;
   U8BIT *pmt;
   U8BIT service_type;
   SI_STRING_DESC *service_name;
   SI_SHORT_EVENT_DESC *event_desc;
} S_CIP_TUNE_DEL_SYS_DESC;

typedef struct ci_operator_nit
{
   U16BIT cicam_onet_id;
   U32BIT cicam_identifier;
   U32BIT lang_code;
   U8BIT profile_name_length;
   U8BIT *profile_name;
   SI_NIT_TABLE *table;
} S_CIP_OPERATOR_NIT;

typedef struct ci_host_info
{
   BOOLEAN standby;
   U8BIT num_service_types;
   U32BIT service_types;
   U16BIT delivery_types;
   U16BIT app_types;
} S_CIP_HOST_INFO;

typedef struct ci_operator_info
{
   U16BIT cicam_onet_id;
   U32BIT cicam_identifier;
} S_CIP_OPERATOR_INFO;

typedef struct ci_operator_search
{
   E_CIP_OPERATOR_SEARCH_REQUEST_TYPE refresh_request;
   U16BIT refresh_date;
   U8BIT refresh_hour;
   U8BIT refresh_min;
} S_CIP_OPERATOR_SEARCH;

typedef struct ci_licence_update
{
   U8BIT slot_id;
   U8BIT cicam_id[8];
   U8BIT cicam_id_len;
   U8BIT raw_uri[CIP_URI_LEN];
   U8BIT *licence;
   U16BIT licence_len;
} S_CIP_LICENCE_UPDATE;

typedef struct ci_query_param
{
   E_CI_QUERY query;
   U32BIT module;
   union
   {
      S_CIP_TUNE_SERVICE_INFO tune_service;
      S_CIP_TUNE_DEL_SYS_DESC tune_del_sys;
      S_CIP_OPERATOR_NIT nit;
      S_CIP_HOST_INFO host_info;
      S_CIP_OPERATOR_SEARCH op_search;
      S_CIP_OPERATOR_INFO op_info;
      S_CIP_LICENCE_UPDATE licence_info;
   } u;
} S_CIP_QUERY_PARAM;

typedef struct
{
   U32BIT module;
   U8BIT reply;
} S_CIP_RELEASE_REPLY;

typedef U32BIT (*F_CIP_CALLBACK)(S_CIP_QUERY_PARAM *);

/*---Global Function prototypes for public use---------------------------------*/

void CIP_OpenEngine(F_CIP_CALLBACK callback );

void CIP_EnterCIMenu(U8BIT slot_id);

U8BIT* CIP_GetCIModuleName(U8BIT slot_id);

U8BIT CIP_GetCIScreenType(U8BIT slot_id);

U8BIT* CIP_GetCIMenuScreenTitle(U8BIT slot_id);

U8BIT* CIP_GetCIMenuScreenSubtitle(U8BIT slot_id);

U8BIT CIP_GetCIMenuScreenNumItems(U8BIT slot_id);

U8BIT* CIP_GetCIMenuScreenItemText(U8BIT slot_id, U8BIT item);

U8BIT* CIP_GetCIMenuScreenBottomText(U8BIT slot_id);

void CIP_SetCIMenuScreenResponse(U8BIT slot_id, U8BIT response);

U8BIT* CIP_GetCIEnquiryScreenText(U8BIT slot_id);

U8BIT CIP_GetCIEnqScreenHideResponse(U8BIT slot_id);

U8BIT CIP_GetCIEnqScreenResponseLength(U8BIT slot_id);

void CIP_SetCIEnquiryScreenResponse(U8BIT slot_id, U8BIT ok_cancel,
   U8BIT *response_str_ptr);

U8BIT CIP_GetCIScreenCloseDelay(U8BIT slot_id);

void CIP_CloseCIScreen(U8BIT slot_id);

void CIP_SetHostCountryCode(U32BIT code);

void CIP_SetHostLanguageCode(U32BIT code);

void CIP_SetDisplayCharacterTables(U8BIT *tables, U16BIT len);

void CIP_SetInputCharacterTables(U8BIT *tables, U16BIT len);

U16BIT CIP_GetSlotStatus(U8BIT slot_id, U8BIT *pmt,
   U8BIT *ci_protection_descriptor);

BOOLEAN CIP_IsConditionalAccessUsed(U8BIT *pmt);

void CIP_ReportPmt(U8BIT slot_id, U8BIT *pmt);

void CIP_GetUsageRulesInfo(U8BIT slot_id, U16BIT service_id,
                           U8BIT uri[CIP_URI_LEN]);

void CIP_GetDefaultUsageRulesInfo(U8BIT raw_uri[CIP_URI_LEN]);

void CIP_UpdateUsageRules(U8BIT orig_uri[CIP_URI_LEN],
                          U8BIT new_uri[CIP_URI_LEN]);

U32BIT CIP_GetRetentionLimit(U8BIT uri[CIP_URI_LEN]);

void CIP_ApplyUsageRulesInfo(U8BIT *uri);

void CIP_ApplyUsageRulesInfoForPlayback(U8BIT *uri);

void CIP_ApplyCCKeys(U8BIT path);

void CIP_ClearCCKeys(U8BIT path);

BOOLEAN CIP_IsHDCPRequired(U16BIT service_id);

void CIP_AppStopped(void);

U8BIT CIP_GetSlotIdForModule(U32BIT module);

BOOLEAN CIP_TuneReply(U8BIT path, U32BIT module, E_CIP_TUNE_STATUS status);

BOOLEAN CIP_AskRelease(U32BIT module);

BOOLEAN CIP_RequestOperatorStatus(U32BIT module);

BOOLEAN CIP_OperatorExit(void);

BOOLEAN CIP_StartOperatorSearch(U32BIT module);

void CIP_SetRecordOperatingMode(U8BIT slot_id, U8BIT mode, U16BIT service_id);

BOOLEAN CIP_SendRecordStart(U8BIT slot_id, U16BIT program_number, U8BIT *pin_string);

BOOLEAN CIP_SendRecordStop(U8BIT slot_id);

BOOLEAN CIP_SendPlaybackLicence(U8BIT slot_id, U16BIT program_number, U8BIT *licence,
   U16BIT licence_len);

U8BIT *CIP_GetRecordingLicence(U8BIT slot_id, U8BIT * licence_status, U16BIT * licence_len,
                               U8BIT raw_uri[CIP_URI_LEN]);

U8BIT *CIP_GetPlaybackLicence(U8BIT slot_id, U8BIT * licence_status, U16BIT * licence_len,
                              U8BIT raw_uri[CIP_URI_LEN]);

void CIP_SendCicamLicenceStatus(U8BIT slot_id, U32BIT status);

BOOLEAN CIP_GetCicamId(U8BIT slot_id, U8BIT cicam_id[8]);

U8BIT CIP_FindSlotForCicamId(U8BIT cicam_id[8]);

BOOLEAN CIP_CheckCicamPin(U8BIT slot_id, U8BIT *pin_data);

BOOLEAN CIP_GetRecordingPinInfo(U8BIT slot_id, U8BIT *status, U8BIT *age_rating,
   U8BIT **private_data, U16BIT *date_code, U8BIT *hour, U8BIT *min, U8BIT *sec);

BOOLEAN CIP_SendPinPlayback(U8BIT slot_id, U8BIT age_rating, U8BIT *private_data);

#endif /* CI_PLUS_CONTROL_H */

/******************************************************************************
** End of file
******************************************************************************/