dsm_types.h File Reference

DSM-CC types used for client control. More...

#include "dvblocator.h"

Go to the source code of this file.

Data Structures
struct	S_CarouselInfoFileGroup
struct	s_SsuModelVersion
union	U_StatusRef
struct	s_SsuConfig

Macros
#define	INVALID_CAROUSEL_ID   0xFFFFFFFF
#define	UNKNOWN_CAROUSEL_ID   0xFFFFFFFE
#define	OC_LOAD_FILE_GROUP_CHANGE   OC_FILE_GROUP_LIST_CHANGE

Typedefs
typedef struct s_SsuModelVersion	S_SsuModelVersion
typedef U32BIT	H_DsmEvent
typedef struct s_DsmCarousel *	H_ObjCarousel
typedef struct s_DsmCarousel *	H_DsmCarousel
typedef struct s_DsmControl *	H_DsmControl
typedef void *	H_UsrRef
typedef void(*	F_SsuStatus )(H_DsmCarousel hCarousel, E_UCLoadStatus status, U_StatusRef sr, U32BIT data)
	SSU callback to inform client of status. More...
typedef BOOLEAN(*	F_SsuWanted )(U32BIT grp_id, U32BIT grp_size, S_SsuModelVersion *smv)
	SSU callback to ask client whether the download details matches the product and is a valid/required sofware upgrade. More...
typedef H_UsrRef(*	F_SsuStartModule )(E_ModuleType mtyp, U8BIT *name)
	SSU callback to ask client whether if client wants to download data connected to this module. On returning TRUE, this is always followed by calls to F_SsuWantModuleData() and F_SsuSaveModuleData(). Another call to this function will only occur after SSU_LOAD_COMPLETE event. More...
typedef BOOLEAN(*	F_SsuWantModuleData )(H_UsrRef usrRef, U32BIT moduleRef, U32BIT offset, U32BIT size, U32BIT crc)
	SSU callback function supplied by client which DSM-CC calls to check whether client requires this module. It is expected that the client may keep previously downloaded modules in NVM, and therefore avoid repeating downloads if power cycle interrupted a previously started update. More...
typedef void(*	F_SsuSaveModuleData )(H_UsrRef usrRef, U32BIT moduleRef, U32BIT offset, U32BIT size, U8BIT *data)
	SSU callback function supplied by client - called when download of a module has completed. The data will remain in memory after returning from this funcrtion and until the client calls DSMCC_SsuUnloadModule. More...
typedef struct s_SsuConfig	S_SsuConfig

Enumerations
enum	E_DsmRstMode { RST_MODE_FORCE, RST_MODE_PENDING }
enum	E_OCLoadStatus {   OC_LOAD_UNINITIATED = 0, OC_LOAD_IN_PROGRESS, OC_LOAD_BOOTED, OC_LOAD_COMPLETED,   OC_LOAD_ABORTED_TIMEOUT, OC_LOAD_ABORTED_PATH_ERROR, OC_LOAD_ABORTED_ERROR, OC_LOAD_ABORTED_UNLOAD,   OC_FILE_GROUP_LIST_LOADED, OC_FILE_GROUP_LIST_CHANGE, OC_FILE_GROUP_VERS_CHANGE }
enum	E_UCLoadStatus {   SSU_NOT_AVAILABLE, SSU_CRSL_READY, SSU_LOAD_STARTING, SSU_LOAD_COMPLETE,   SSU_LOAD_ABORTED, SSU_CRSL_DONE, SSU_CRSL_ABORT, SSU_CRSL_UNLOAD }
enum	E_ModuleType { MTYP_EXECUTABLE, MTYP_MEMORY_MAP, MTYP_DATA_MODULE }

Detailed Description

DSM-CC types used for client control.

Date

23/01/2014

Author

Adam Sturtridge

Definition in file dsm_types.h.

Typedef Documentation

typedef void(* F_SsuSaveModuleData)(H_UsrRef usrRef, U32BIT moduleRef, U32BIT offset, U32BIT size, U8BIT *data)

SSU callback function supplied by client - called when download of a module has completed. The data will remain in memory after returning from this funcrtion and until the client calls DSMCC_SsuUnloadModule.

Parameters

usrRef	Reference returned by F_SsuStartModule()
moduleRef	Reference to module data
offset	Offset for the module data
size	Size of the module data
data	Pointer to the data for this module data

Returns

void

Definition at line 198 of file dsm_types.h.

typedef H_UsrRef(* F_SsuStartModule)(E_ModuleType mtyp, U8BIT *name)

SSU callback to ask client whether if client wants to download data connected to this module. On returning TRUE, this is always followed by calls to F_SsuWantModuleData() and F_SsuSaveModuleData(). Another call to this function will only occur after SSU_LOAD_COMPLETE event.

Parameters

mtyp	Type of module download
name	Name of module download

Returns

H_UsrRef - NULL if module data is not required

Definition at line 170 of file dsm_types.h.

typedef void(* F_SsuStatus)(H_DsmCarousel hCarousel, E_UCLoadStatus status, U_StatusRef sr, U32BIT data)

SSU callback to inform client of status.

Parameters

hCarousel	Handle to the DSMCC Update Carousel
status	Current load status
sr	Meaning depends on status value: SSU_NOT_AVAILABLE - sr.id is OUI SSU_CRSL_READY - sr.id is Group ID SSU_LOAD_STARTING - sr.ur is H_UsrRef SSU_LOAD_COMPLETE - sr.ur is H_UsrRef SSU_LOAD_ABORTED - sr.ur is H_UsrRef SSU_CRSL_DONE - sr.id is Group ID SSU_CRSL_ABORT - sr.id is OUI SSU_CRSL_UNLOAD - sr.id is OUI
data	Extra data

Returns

void

Definition at line 148 of file dsm_types.h.

typedef BOOLEAN(* F_SsuWanted)(U32BIT grp_id, U32BIT grp_size, S_SsuModelVersion *smv)

SSU callback to ask client whether the download details matches the product and is a valid/required sofware upgrade.

Parameters

grp_id	Group ID (Bits: 1-15 are Download ID)
grp_size	Total size of group (i.e. size of all modules for this image data)
swv	Model and Version details for this group

Returns

BOOLEAN - TRUE if this is required

Definition at line 159 of file dsm_types.h.

typedef BOOLEAN(* F_SsuWantModuleData)(H_UsrRef usrRef, U32BIT moduleRef, U32BIT offset, U32BIT size, U32BIT crc)

SSU callback function supplied by client which DSM-CC calls to check whether client requires this module. It is expected that the client may keep previously downloaded modules in NVM, and therefore avoid repeating downloads if power cycle interrupted a previously started update.

Parameters

usrRef	Reference returned by F_SsuStartModule()
moduleRef	Reference to module data
offset	Offset for the module data
size	Size of this module data
crc	CRC for of this module data

Returns

BOOLEAN - TRUE if module is required

Definition at line 184 of file dsm_types.h.