stbhwmem.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 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 _STBHWMEM_H

#define _STBHWMEM_H

#include "techtype.h"

//---Constant and macro definitions for public use-----------------------------
// IMPORTANT NOTE: The following definition musts comply with that defined in el_nvram.c of the loader
// source code. The number of NVRAM bytes that are reserved for the loader are defined in the first two
// bytes of NVRAM. The area immediately following those 2 bytes are the Euroloader NVM area itself
#define ELOAD_RESERVED_NVM_OFFSET      0  // offset of NVM reserved for Euroloader
#define ELOAD_RESERVED_NVM_SIZE_WIDTH  2  // width in bytes of variable denoting no.
                                          // of Euroloader NVM bytes

#define ELOAD_NVM_DATA_OFFSET ELOAD_RESERVED_NVM_SIZE_WIDTH // E'loader data starts immed. after size variable

//---Enumerations for public use-----------------------------------------------

/* Key values for data items that can be stored in secure NVM */
enum
{
   SECURE_NVM_DEFAULT_ENCRYPTION_KEY,           /*   0 */
   SECURE_NVM_DEFAULT_ENC_INIT_VECTOR,          /*   1 */
   SECURE_NVM_CI_PLUS_ROOT_CERT,                /*   2 */
   SECURE_NVM_CI_PLUS_BRAND_CERT,               /*   3 */
   SECURE_NVM_CI_PLUS_DEVICE_CERT,              /*   4 */
   SECURE_NVM_CI_PLUS_DEVICE_KEY,               /*   5 */
   SECURE_NVM_CI_PLUS_DH_P,                     /*   6 */
   SECURE_NVM_CI_PLUS_DH_G,                     /*   7 */
   SECURE_NVM_CI_PLUS_DH_Q,                     /*   8 */
   SECURE_NVM_CI_PLUS_PRNG_KEY_K,               /*   9 */
   SECURE_NVM_CI_PLUS_PRNG_SEED,                /*  10 */
   SECURE_NVM_CI_PLUS_SIV,                      /*  11 */
   SECURE_NVM_CI_PLUS_SLK,                      /*  12 */
   SECURE_NVM_CI_PLUS_CLK,                      /*  13 */
   SECURE_NVM_CI_PLUS_CONTEXTS,                 /*  14 */
   SECURE_NVM_MHEG5_PRIVATE_KEY,                /*  15 */
   SECURE_NVM_MHEG5_PRIVATE_KEY_VERSION,        /*  16 */
   SECURE_NVM_SOFTWARE_UPGRADE_PUBLIC_KEY,      /*  17 */
   SECURE_NVM_SOFTWARE_UPGRADE_SHARED_KEY       /*  18 */
};

//---Global type defs for public use-------------------------------------------

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

#include "stbhwdsk.h" /* for E_STB_DSK_FILE_MODE */

void STB_MEMInitialiseRAM(void);

void STB_MEMInitialiseNVM(void);

BOOLEAN STB_MEMReadNVM(U32BIT addr, U32BIT bytes, U8BIT *dst_addr);

BOOLEAN STB_MEMWriteNVM(U32BIT addr, U32BIT bytes, U8BIT *src_addr);

void* STB_MEMReadSecureVariable(U8BIT key, U32BIT *len);

void STB_MEMReleaseSecureVariable(void *value);

BOOLEAN STB_MEMWriteSecureVariable(U8BIT key, void *value, U32BIT len);

const void* STB_MEMReadSecureConstant(U8BIT key, U32BIT *len);

U32BIT STB_MEMGetNVMSize(void);

U32BIT STB_MEMGetNVMOffset(void);

U8BIT STB_MEMGetNVMAlign(void);

void* STB_MEMGetSysRAM(U32BIT bytes);

void* STB_MEMResizeSysRAM(void *ptr, U32BIT new_num_bytes);

void STB_MEMFreeSysRAM(void *block);

U8BIT STB_MEMSysRAMUsed(void);

void* STB_MEMGetAppRAM(U32BIT bytes);

void* STB_MEMResizeAppRAM(void *ptr, U32BIT new_num_bytes);

void STB_MEMFreeAppRAM(void *block);

U8BIT STB_MEMAppRAMUsed(void);


BOOLEAN STB_MEMConfigMloaderForUpgrade(void *loader_data, U32BIT data_size);
BOOLEAN STB_MEMReadMloaderData(void *buffer, U32BIT size);
BOOLEAN STB_MEMWriteMloaderData(void *buffer, U32BIT size);

BOOLEAN STB_NVMFileSize(U8BIT *filename, U32BIT *filesize);

void* STB_NVMOpenFile(U8BIT *name, E_STB_DSK_FILE_MODE mode);

void STB_NVMCloseFile(void *file);

U32BIT STB_NVMReadFile(void *file, U8BIT *data, U32BIT size);

U32BIT STB_NVMWriteFile(void *file, U8BIT *data, U32BIT size);

BOOLEAN STB_NVMDeleteFile(U8BIT *filename);

BOOLEAN STB_NVMMoveFile(U8BIT* oldname, U8BIT* newname);

void* STB_NVMOpenDirectory(U8BIT *dir_name);

BOOLEAN STB_NVMReadDirectory(void *dir, U8BIT *filename, U16BIT filename_len,
   E_STB_DIR_ENTRY_TYPE *entry_type);

void STB_NVMCloseDirectory(void *dir);

#endif //  _STBHWMEM_H