📄 sysenv_api.h
字号:
/************************************************************************
*
* sysenv_api.h
*
* The 'sysenv' module implements the system environment variable
* write and read functions, which operate on a RAM and FLASH
* storage media. The functions are normally called through the
* SYSCON api.
*
*
* ######################################################################
*
* Copyright (c) 1999-2000 MIPS Technologies, Inc. All rights reserved.
*
* Unpublished rights reserved under the Copyright Laws of the United States of
* America.
*
* This document contains information that is proprietary to MIPS Technologies,
* Inc. ("MIPS Technologies"). Any copying, modifying or use of this information
* (in whole or in part) which is not expressly permitted in writing by MIPS
* Technologies or a contractually-authorized third party is strictly
* prohibited. At a minimum, this information is protected under unfair
* competition laws and the expression of the information contained herein is
* protected under federal copyright laws. Violations thereof may result in
* criminal penalties and fines.
* MIPS Technologies or any contractually-authorized third party reserves the
* right to change the information contained in this document to improve
* function, design or otherwise. MIPS Technologies does not assume any
* liability arising out of the application or use of this information. Any
* license under patent rights or any other intellectual property rights owned
* by MIPS Technologies or third parties shall be conveyed by MIPS Technologies
* or any contractually-authorized third party in a separate license agreement
* between the parties.
* The information contained in this document constitutes one or more of the
* following: commercial computer software, commercial computer software
* documentation or other commercial items. If the user of this information, or
* any related documentation of any kind, including related technical data or
* manuals, is an agency, department, or other entity of the United States
* government ("Government"), the use, duplication, reproduction, release,
* modification, disclosure, or transfer of this information, or any related
* documentation of any kind, is restricted in accordance with Federal
* Acquisition Regulation 12.212 for civilian agencies and Defense Federal
* Acquisition Regulation Supplement 227.7202 for military agencies. The use of
* this information by the Government is further restricted in accordance with
* the terms of the license agreement(s) and/or applicable contract terms and
* conditions covering this information from MIPS Technologies or any
* contractually-authorized third party.
*
************************************************************************/
#ifndef SYSENV_API_H
#define SYSENV_API_H
/************************************************************************
* Include files
************************************************************************/
#include "sysdefs.h"
#include "syserror.h"
/************************************************************************
* SYSENV, ERROR completion codes
*************************************************************************/
typedef enum SYSENV_error_ids
{
ERROR_SYSENV_OUT_OF_MEMORY /* No more dynamic memory */
= ERROR_SYSENV,
ERROR_SYSENV_ENV_VAR_TOO_BIG, /* environment var size too big */
ERROR_SYSENV_NO_VARIABLE, /* environment var not created */
ERROR_SYSENV_INVALID_INDEX, /* environment var index invalid */
ERROR_SYSENV_UPDATE_READ_REFS, /* all references for env
variables must be re-read */
ERROR_SYSENV_FLASH_INVALID, /* FLASH has been corrupted */
/******* ADD NEW SYSENV ERROR TAGS JUST BEFORE THIS LINE ONLY *******/
} t_SYSENV_error_ids;
/************************************************************************
* System Definitions
*************************************************************************/
/* User environment. */
#define SYS_USER_ENVIRONMENT_MAX_INDEX 99
#define SYS_USER_ENVIRONMENT_DATA_SIZE 124
typedef struct sys_user_environment_var
{
UINT32 index ; /* index of this env. variable */
UINT32 size ; /* size of user environment data */
void *data_inout ;/* input/output pointer for user env. data */
} t_user_environment_var ;
/************************************************************************
* Public variables
************************************************************************/
/************************************************************************
* Public functions
************************************************************************/
/************************************************************************
*
* SYSENV_check_state
* Description :
* -------------
*
* Check the 'sysenv' state.
*
*
*
*
* Parameters :
* ------------
*
* -
*
*
* Return values :
* ---------------
* ERROR_SYSENV_FLASH_INVALID, sysenv is corrupted.
* 'OK'(=0), successfull initialization
*
************************************************************************/
INT32 SYSENV_check_state( void ) ;
/************************************************************************
*
* SYSENV_init
* Description :
* -------------
*
* Initializes the 'sysenv' module.
*
*
*
*
* Parameters :
* ------------
*
* -
*
*
* Return values :
* ---------------
*
* 'OK'(=0), successfull initialization
*
************************************************************************/
INT32 SYSENV_init( void ) ;
/************************************************************************
*
* SYSENV_read
* Description :
* -------------
*
* Read a system environment variable. Unformatted data are read from
* a data array, accessed via an 'index'. Data are not copied, just
* a pointer reference is being returned to the data array and the
* actual size of the data, which have been stored.
*
*
* Parameters :
* ------------
*
* 'var', INOUT, data are not copied
*
* Return values :
* ---------------
*
* 'OK'(=0), returned parameter value and size are valid.
*
*
************************************************************************/
INT32 SYSENV_read( t_user_environment_var *var ) ;
/************************************************************************
*
* SYSENV_write
* Description :
* -------------
*
* Write data to a system environment variable. Unformatted data are
* written to a data array, accessed via an 'index'. Data are copied,
* into non-volatile memory (FLASH) and a pointer reference is
* returned to the data-array of this variable in FLASH. The actual
* size is stored too, to be returned in a 'read' for this variable.
* A system variable is being created with the first 'write' operation
* to this variable and deleted, if any succeeding 'write' to
* this 'index' contains a 'size' parameter of '0'.
*
*
* Parameters :
* ------------
*
* 'var', INOUT, data are copied into non-volatile memory
* and the storage-pointer for this memory
* is being returned in the 'data_inout'
* parameter of the parameter block.
*
* Return values :
* ---------------
*
* 'OK'(=0), returned parameter value and size are valid.
*
*
************************************************************************/
INT32 SYSENV_write( t_user_environment_var *var ) ;
#endif /* #ifndef SYSENV_API_H */
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -