stbcicc.h File Reference

CI Content Control. More...

#include "techtype.h"

Go to the source code of this file.

Macros
#define	CIP_CICAM_ID_LEN   8
#define	CIP_URI_LEN   8
#define	CIP_MAX_PIN_LENGTH   8
#define	CIP_PIN_PRIVATE_DATA_SIZE   15

Functions
void	STB_CiCcInitialise (void)
	CI content control support initialise.
void	STB_CiCcRemove (U8BIT slot_id)
	Handle CAM removal from slot. More...
void	STB_CiCcNotifyModuleInsert (U8BIT slot_id)
	Notify module insertion. More...
void	STB_CiCcNotifyModuleRemove (U8BIT slot_id)
	Notify module removal. More...
BOOLEAN	STB_CiCcIsSlotReady (U8BIT slot_id)
	Return whether CI slot is ready. More...
void	STB_CiCcSetSDTAcquisitionStatus (BOOLEAN complete)
	To implement the first part of the diagram in "Figure 10.2: Shunning Operation" of ci-plus_specification_v1.3.2.pdf, this function passes the status of the SDT acquisition to the ci+ glue. More...
BOOLEAN	STB_CiCcIsServiceAllowed (U8BIT slot_id, U8BIT *ci_prot_desc)
	Tell whether the service is allowed. This function checks whether the CI Protection Descriptor allows the service to be routed through the CI module. More...
BOOLEAN	STB_CiCcAuthenticated (U8BIT slot_id)
	Tell whether authenticated CI+ module is in the slot. More...
U8BIT	STB_CiCcFindSlotForCicamId (U8BIT cicam_id[CIP_CICAM_ID_LEN])
	Checks CAMs in all slots to find the one with the given CAM id. More...
void	STB_CiCcGetUsageRulesInfo (U8BIT slot_id, U16BIT service_id, U8BIT uri[CIP_URI_LEN])
	Return the current URI for the given service. More...
void	STB_CiCcGetDefaultUsageRulesInfo (U8BIT raw_uri[CIP_URI_LEN])
	Sets the default URI values into the given array. The URI requires HDCP. More...
U32BIT	STB_CiCcGetRetentionLimit (U8BIT uri[CIP_URI_LEN])
	Return the retention limit given a packed URI. More...
void	STB_CiCcApplyUsageRulesInfo (U8BIT *uri)
	Apply the given Usage Rules Information. More...
void	STB_CiCcApplyUsageRulesInfoForPlayback (U8BIT *uri)
	Apply the given Usage Rules Information for playback. More...
BOOLEAN	STB_CiCcIsHDCPRequired (U16BIT service_id)
	Tell whether the given service requires HDCP. More...
BOOLEAN	STB_CiCcSendPlaybackLicence (U8BIT slot_id, U16BIT program_number, U8BIT *licence, U16BIT licence_len)
	Sends a CICAM licence to a module during playback, which will result in a modified licence being notified through STB_CINotifyCicamLicence. More...
U8BIT *	STB_CiCcGetRecordingLicence (U8BIT slot_id, U8BIT *licence_status, U16BIT *licence_len, U8BIT raw_uri[CIP_URI_LEN])
	Returns the last licence received from the CAM when recording. More...
U8BIT *	STB_CiCcGetPlaybackLicence (U8BIT slot_id, U8BIT *licence_status, U16BIT *licence_len, U8BIT raw_uri[CIP_URI_LEN])
	Returns the last licence received from the CAM during playback. More...
BOOLEAN	STB_CiCcSendPin (U8BIT slot_id, U8BIT *pin_data)
	Called by the host to check whether a CAM pin is valid. An STB_EVENT_CI_PIN_STATUS event will be sent to notify the host of the validity, or otherwise, of the pin. More...
BOOLEAN	STB_CiCcGetRecordingPinInfo (U8BIT slot_id, U8BIT *status, U8BIT *age_rating, U8BIT **private_data, U16BIT *date_code, U8BIT *hour, U8BIT *min, U8BIT *sec)
	Returns the information to be stored with a pin event when recording. More...
BOOLEAN	STB_CiCcSendPinPlayback (U8BIT slot_id, U8BIT age_rating, U8BIT *private_data)
	Sends a pin event to the CAM during playback. More...
void	STB_CiCcSetRecordOperatingMode (U8BIT slot_id, U32BIT mode, U16BIT service_id)
	Sets the record operating mode for the given slot id. More...
BOOLEAN	STB_CiCcSendRecordStart (U8BIT slot_id, U16BIT program_number, U8BIT *pin_string)
	Called by the app when a recording is to be started on a CA protected service. More...
BOOLEAN	STB_CiCcSendRecordStop (U8BIT slot_id)
	Called by the app when a recording is stopped or completes. More...

Detailed Description

CI Content Control.

Date

28 November 2016

Author

Adam Sturtridge

Definition in file stbcicc.h.

Function Documentation

STB_CiCcApplyUsageRulesInfo()

void STB_CiCcApplyUsageRulesInfo

(

U8BIT *

uri

)

Apply the given Usage Rules Information.

Parameters

uri	- Usage Rules Information

STB_CiCcApplyUsageRulesInfoForPlayback()

void STB_CiCcApplyUsageRulesInfoForPlayback

(

U8BIT *

raw_uri

)

Apply the given Usage Rules Information for playback.

Parameters

uri	- Usage Rules Information

Definition at line 578 of file stbcicc.c.

STB_CiCcAuthenticated()

BOOLEAN STB_CiCcAuthenticated

(

U8BIT

slot_id

)

Tell whether authenticated CI+ module is in the slot.

Parameters

slot_id

slot ID (0, 1, ...)

Returns

BOOLEAN - TRUE if authenticated

Tell whether authenticated CI+ module is in the slot.

Parameters

slot_id

slot ID (0, 1, ...)

Returns

BOOLEAN - TRUE if authenticated

Definition at line 374 of file stbcicc.c.

STB_CiCcFindSlotForCicamId()

U8BIT STB_CiCcFindSlotForCicamId

(

U8BIT

cicam_id[CIP_CICAM_ID_LEN]

)

Checks CAMs in all slots to find the one with the given CAM id.

Parameters

cicam_id

- CAM id to look for

Returns

slot id if found, INVALID_RES_ID if not found

Definition at line 399 of file stbcicc.c.

STB_CiCcGetDefaultUsageRulesInfo()

void STB_CiCcGetDefaultUsageRulesInfo

(

U8BIT

raw_uri[CIP_URI_LEN]

)

Sets the default URI values into the given array. The URI requires HDCP.

Parameters

raw_uri

- returns with the default URI settings

Definition at line 477 of file stbcicc.c.

STB_CiCcGetPlaybackLicence()

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

Returns the last licence received from the CAM during playback.

Parameters

slot_id	- slot
licence_status	- status value associated with the licence
licence_len	- pointer to return the licence length in bytes
raw_uri	- returns with the packed URI data associated with the licence

Returns

pointer to the licence data, mustn't be freed. NULL if no licence

Definition at line 1443 of file stbcicc.c.

STB_CiCcGetRecordingLicence()

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

Returns the last licence received from the CAM when recording.

Parameters

slot_id	- slot
licence_status	- status value associated with the licence
licence_len	- pointer to return the licence length in bytes
raw_uri	- returns with the packed URI data associated with the licence

Returns

pointer to the licence data, mustn't be freed. NULL if no licence

Definition at line 1292 of file stbcicc.c.

STB_CiCcGetRecordingPinInfo()

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

Returns the information to be stored with a pin event when recording.

Parameters

slot_id	- slot being used for the recording
status	- pin status code
age_rating	- returns the age rating supplied with the pin event
private_data	- returns a pointer to the private data to be saved - don't free
date_code	- MJD UTC date code when the pin is to be applied
hour	- UTC hour when the pin is to be applied
min	- UTC minute when the pin is to be applied
sec	- UTC second when the pin is to be applied

Returns

TRUE if the info is returned, FALSE otherwise

Definition at line 1000 of file stbcicc.c.

STB_CiCcGetRetentionLimit()

U32BIT STB_CiCcGetRetentionLimit

(

U8BIT

raw_uri[CIP_URI_LEN]

)

Return the retention limit given a packed URI.

Parameters

uri	- Usage Rules Information

Returns

Retention limit in minutes (0 = no limit)

Definition at line 495 of file stbcicc.c.

STB_CiCcGetUsageRulesInfo()

void STB_CiCcGetUsageRulesInfo	(	U8BIT	slot_id,
		U16BIT	service_id,
		U8BIT	raw_uri[CIP_URI_LEN]
	)

Return the current URI for the given service.

Parameters

slot_id	- slot ID
service_id	- service ID
uri	- the URI for the service

Returns

URI for the service if available or "empty" URI otherwise

Definition at line 449 of file stbcicc.c.

STB_CiCcIsHDCPRequired()

BOOLEAN STB_CiCcIsHDCPRequired

(

U16BIT

service_id

)

Tell whether the given service requires HDCP.

Parameters

service_id

- Service ID

Definition at line 609 of file stbcicc.c.

STB_CiCcIsServiceAllowed()

BOOLEAN STB_CiCcIsServiceAllowed	(	U8BIT	slot_id,
		U8BIT *	ci_prot_desc
	)

Tell whether the service is allowed. This function checks whether the CI Protection Descriptor allows the service to be routed through the CI module.

Parameters

slot_id	slot ID (0, 1, ...)
ci_prot_desc	CI Protection Descriptor for the service

Returns

BOOLEAN - TRUE if allowed

Definition at line 349 of file stbcicc.c.

STB_CiCcIsSlotReady()

BOOLEAN STB_CiCcIsSlotReady

(

U8BIT

slot_id

)

Return whether CI slot is ready.

Parameters

slot_id

- slot ID (0, 1, ...)

Returns

BOOLEAN - TRUE if ready

Definition at line 319 of file stbcicc.c.

STB_CiCcNotifyModuleInsert()

void STB_CiCcNotifyModuleInsert

(

U8BIT

slot_id

)

Notify module insertion.

Parameters

slot_id

- slot ID for module

Definition at line 170 of file stbcicc.c.

STB_CiCcNotifyModuleRemove()

void STB_CiCcNotifyModuleRemove

(

U8BIT

slot_id

)

Notify module removal.

Parameters

slot_id

- slot ID for module

Definition at line 249 of file stbcicc.c.

STB_CiCcRemove()

void STB_CiCcRemove

(

U8BIT

slot_id

)

Handle CAM removal from slot.

Parameters

slot_id

zero-based CI slot identifier (0, 1, ...)

Definition at line 275 of file stbcicc.c.

STB_CiCcSendPin()

BOOLEAN STB_CiCcSendPin	(	U8BIT	slot_id,
		U8BIT *	pin_data
	)

Called by the host to check whether a CAM pin is valid. An STB_EVENT_CI_PIN_STATUS event will be sent to notify the host of the validity, or otherwise, of the pin.

Parameters

slot_id	- slot
pin_data	- ASCII encoded pin data, null terminated

Returns

TRUE if the pin was sent successfully, FALSE otherwise

Definition at line 873 of file stbcicc.c.

STB_CiCcSendPinPlayback()

BOOLEAN STB_CiCcSendPinPlayback	(	U8BIT	slot_id,
		U8BIT	age_rating,
		U8BIT *	private_data
	)

Sends a pin event to the CAM during playback.

Parameters

slot_id	- slot
age_rating	- rating as provided by the pin event during recording
private_data	- pin private data as provided by the pin event during recording

Returns

TRUE on success, FALSE otherwise

Definition at line 1037 of file stbcicc.c.

STB_CiCcSendPlaybackLicence()

BOOLEAN STB_CiCcSendPlaybackLicence	(	U8BIT	slot_id,
		U16BIT	program_number,
		U8BIT *	licence,
		U16BIT	licence_len
	)

Sends a CICAM licence to a module during playback, which will result in a modified licence being notified through STB_CINotifyCicamLicence.

Parameters

slot_id	- slot
program_number	- program number being played back
licence	- CICAM licence
licence_len	- licence length in bytes

Returns

TRUE if operation succeeded, FALSE otherwise

Definition at line 1324 of file stbcicc.c.

STB_CiCcSendRecordStart()

BOOLEAN STB_CiCcSendRecordStart	(	U8BIT	slot_id,
		U16BIT	program_number,
		U8BIT *	pin_string
	)

Called by the app when a recording is to be started on a CA protected service.

Parameters

slot_id	- slot being used for the recording
program_number	- service ID
pin_string	- pin as a null terminated ascii string

Returns

TRUE on success, but this doesn't mean the recording can start, FALSE otherwise

Definition at line 1110 of file stbcicc.c.

STB_CiCcSendRecordStop()

BOOLEAN STB_CiCcSendRecordStop

(

U8BIT

slot_id

)

Called by the app when a recording is stopped or completes.

Parameters

slot_id

- slot to be, or being, used for recording

Returns

TRUE on success, FALSE otherwise

Parameters

slot_id

- slot being used for the recording

Returns

TRUE on success, FALSE otherwise

Definition at line 1529 of file stbcicc.c.

STB_CiCcSetRecordOperatingMode()

void STB_CiCcSetRecordOperatingMode	(	U8BIT	slot_id,
		U32BIT	mode,
		U16BIT	service_id
	)

Sets the record operating mode for the given slot id.

Parameters

slot_id	- slot to be, or being, used for recording
mode	- operating mode of the host
slot_id	- slot to be used for the recording
mode	- mode in which the host is in
service_id	-

Definition at line 1065 of file stbcicc.c.

STB_CiCcSetSDTAcquisitionStatus()

void STB_CiCcSetSDTAcquisitionStatus

(

BOOLEAN

complete

)

To implement the first part of the diagram in "Figure 10.2: Shunning Operation" of ci-plus_specification_v1.3.2.pdf, this function passes the status of the SDT acquisition to the ci+ glue.

Parameters

sdt_acquisition_status

TRUE if the SDT acquisition is completed (either successfully if the table has been received, or unsuccessfully if the SDT timeout has expired), FALSE if the DVB engine is waiting for an SDT.

To implement the first part of the diagram in "Figure 10.2: Shunning Operation" of ci-plus_specification_v1.3.2.pdf, this function passes the status of the SDT acquisition to the ci+ glue.

Parameters

sdt_acquisition_status

TRUE if the SDT acquisition is completed (either successfully if the table has been received, or unsuccessfully if the SDT timeout has expired), FALSE if the DVB engine is waiting for an SDT.

Definition at line 434 of file stbcicc.c.