kpd_env.h

来自「是一个手机功能的模拟程序」· C头文件 代码 · 共 99 行

/**
 * @file   kpd_env.h
 *
 * Declarations of the Riviera Generic Functions 
 * (except handle message and handle timer).
 *
 * @author   Laurent Sollier ([e-mail])
 * @version 0.1
 */

/*
 * History:
 *
 *   Date          Author       Modification
 *  ----------------------------------------
 *  10/10/2001     L Sollier    Create
 *
 *
 * (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved
 */

#ifndef _KPD_ENV_H_
#define _KPD_ENV_H_

#include "kpd_cfg.h"

#include "rvm_gen.h"

#include "rvf_pool_size.h"	/* Stack & Memory Bank sizes definitions */


/**
 * Mailbox ID used by the SWE.
 */
#define KPD_MAILBOX_USED    RVF_TASK_MBOX_0

/** Size of task stack in bytes. */
#define KPD_STACK_SIZE     RVF_KPD_STACK_SIZE


/**
 * @name Mem bank
 *
 * Memory bank size and watermark.
 */
/*@{*/
#define KPD_MB_PRIM_SIZE      (KPD_MB_BASE_SIZE + KPD_MAX_SUBSCRIBER*(100+3*(KPD_NB_PHYSICAL_KEYS)))
#define KPD_MB_PRIM_WATERMARK (KPD_MB_PRIM_SIZE - 50*KPD_MAX_SUBSCRIBER)
/*@}*/

#if ((!defined DEPENDENCY) && (KPD_MB_PRIM_SIZE != RVF_KPD_MB1_SIZE))
  /* If the KPD Memory Bank sizes defined in rvf_pool_size.h differs from */
  /* this computed one, compilation is STOPPED. */
  #error KPD Memory Bank size mismatch!
#endif


/** Define a structure used to store all the informations related to KPD's task
 *   & MBs identifiers.
 */
typedef struct
{
   T_RVF_MB_ID    prim_id;
   T_RVF_ADDR_ID  addr_id;
   BOOL           swe_is_initialized;
   T_RVM_RETURN   (*error_ft)(T_RVM_NAME        swe_name, 
                              T_RVM_RETURN      error_cause,
                              T_RVM_ERROR_TYPE  error_type,
                              T_RVM_STRING      error_msg);
} T_KPD_ENV_CTRL_BLK;

/**
 * @name Generic functions
 *
 * Generic functions declarations.
 */
/*@{*/


T_RVM_RETURN kpd_get_info(T_RVM_INFO_SWE  *infoSWE);

T_RVM_RETURN kpd_set_info( T_RVF_ADDR_ID  addr_id,
                           T_RV_RETURN    return_path[],
                           T_RVF_MB_ID    bk_id[],
                           T_RVM_RETURN   (*rvm_error_ft)(T_RVM_NAME swe_name, 
                                                          T_RVM_RETURN error_cause, 
                                                          T_RVM_ERROR_TYPE error_type, 
                                                          T_RVM_STRING error_msg));

T_RVM_RETURN kpd_init(void);

T_RVM_RETURN kpd_stop(void);

T_RVM_RETURN kpd_kill(void);

/*@}*/


#endif /* #ifndef _KPD_ENV_H_ */