fc-tourmaline: src/cs/drivers/drv_app/kpd/kpd

annotate src/cs/drivers/drv_app/kpd/kpd_api.h @ 286:ee16d57b32b2

Condat audio_Init(): rm setting of sidetone level The default sidetone level in the absence of audio mode loading is just that, a basic default without any promises of good tuning. In the original TCS211 code this default sidetone level was set in two places: first in L1 init of ABB-via-DSP registers (set to -17 dB), and then initialized again in Condat audio_Init(), this time set to -5 dB. The present change removes the redundant second initialization. The default sidetone level is now -17 dB instead of -5 dB with this change, but again it is just the default; all serious users are now expected to use audio mode config files.

author	Mychaela Falconia <falcon@freecalypso.org>
date	Tue, 09 Nov 2021 02:16:59 +0000
parents	4e78acac3d88
children

rev	line source
0 4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 * @file kpd_api.h
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 * API Definition for keypad driver.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 * This file gathers all the constants, structure and functions declaration
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7 * useful for a keypad driver user.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9 * @author Laurent Sollier (l-sollier@ti.com)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 * @version 0.1
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 /*
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14 * History:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 * Date Author Modification
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 * ----------------------------------------
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 * 10/10/2001 L Sollier Create
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 * (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24 #ifndef _KPD_API_H_
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25 #define _KPD_API_H_
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27 #include "kpd/kpd_cfg.h"
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29 #include "rv/rv_general.h"
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 #include "rvf/rvf_api.h"
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 * @name External types
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 * Types used in API.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38 /@{/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40 /** Definition of the subscriber identification. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41 typedef void* T_KPD_SUBSCRIBER;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 /** Definition of the virtual key identification. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44 typedef UINT8 T_KPD_VIRTUAL_KEY_ID;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46 /** Definition of the notification level (First press, long press, infinite repeat, release). */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 typedef UINT8 T_KPD_NOTIF_LEVEL;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 /** Definition of a set of keys. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 typedef struct { UINT8 nb_notified_keys;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 T_KPD_VIRTUAL_KEY_ID notified_keys[KPD_NB_PHYSICAL_KEYS];
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 } T_KPD_VIRTUAL_KEY_TABLE;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 /@}/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 /** Allowed values for T_KPD_NOTIF_LEVEL type.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58 * If a key is defined with KPD_NO_NOTIF, this key will be deleted from the key list
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59 * notified to the client.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 * But client will can set later as KPD_RELEASE_NOTIF (for exemple)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61 * without calling unsubscribe, subscribe functions.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 #define KPD_NO_NOTIF (0x00)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 /** Allowed values for T_KPD_NOTIF_LEVEL type.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 * If a key is defined with KPD_FIRST_PRESS_NOTIF, client will be notified by :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 * - The immediate key press
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69 #define KPD_FIRST_PRESS_NOTIF (0x01)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 /** Allowed values for T_KPD_NOTIF_LEVEL type.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72 * If a key is defined with KPD_LONG_PRESS, client will be notified by :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 * - The long press if the key is still pressed for a defined time
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74 * (defined in kpd_define_repeat_keys function)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76 #define KPD_LONG_PRESS_NOTIF (0x02)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 /** Allowed values for T_KPD_NOTIF_LEVEL type.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79 * If a key is defined with KPD_INFINITE_REPEAT_NOTIF, client will be notified by :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 * - The long press if the key is still pressed for a defined time
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 * (defined in kpd_define_repeat_keys function)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82 * - The key pressed every defined time (defined in kpd_define_repeat_keys function),
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83 * until the key is released
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85 #define KPD_INFINITE_REPEAT_NOTIF (0x04)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 /** Allowed values for T_KPD_NOTIF_LEVEL type.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 * If a key is defined with KPD_RELEASE_NOTIF, client will be notified by :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 * - the key release
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91 #define KPD_RELEASE_NOTIF (0x08)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 /*************************************************************************/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 /************************ FUNCTIONS PROTOTYPES ***********************/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 /*************************************************************************/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 * @name API functions
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101 * API functions declarations.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103 /@{/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 * function: kpd_subscribe
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 * This function is called by the client before any use of the keypad driver services
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109 * It is called only once.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111 * @param subscriber_p Subscriber identification value (OUT).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112 * @param mode Mode used by the keypad client.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 * @param notified_keys_p Define all the keys the client want to be notified.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 * @param return_path Return path for key pressed.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116 * - RV_OK if operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 * - RV_INTERNAL_ERR if
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118 * - the max of subscriber is reached,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119 * - the software entity is not started, not yet initialized or initialization has
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120 * failed
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121 * - RV_INVALID_PARAMETER if number of virtual keys is not correct.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122 * - RV_MEMORY_ERR if memory reach its size limit.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 * Message returned: KPD_STATUS_MSG with operation = KPD_SUBSCRIBE_OP.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125 * Available values for status_value are:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 * - KPD_PROCESS_OK if asynchronous operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 * - KPD_ERR_KEYS_TABLE if at least one key is not available in the requested mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 * - KPD_ERR_RETURN_PATH_EXISTING if subscriber return path is already defined by
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 * another subscriber,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 * - KPD_ERR_INTERNAL if an internal error occured.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132 * @note
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133 * - If number of notified key is KPD_NB_PHYSICAL_KEYS, client has not to fulfill
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134 * the structure, this will be automatically done by the software entity.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136 T_RV_RET kpd_subscribe(T_KPD_SUBSCRIBER* subscriber_p,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137 T_KPD_MODE mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 T_KPD_VIRTUAL_KEY_TABLE* notified_keys_p,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139 T_RV_RETURN return_path);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 * function: kpd_unsubscribe
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 * This function unsubscribes a client from the keypad driver.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146 * @param subscriber_p Subscriber identification value (IN/OUT).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 * - RV_OK if operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149 * - RV_INVALID_PARAMETER if subscriber identification is incorrect.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 * - RV_MEMORY_ERR if memory reach its size limit.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152 * - Message: No message is returned for asynchronous processing.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154 T_RV_RET kpd_unsubscribe( T_KPD_SUBSCRIBER* subscriber_p);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157 * function: kpd_define_key_notification
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159 * This function defines notification type for a set of keys.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160 * By default, all the keys are defined as KPD_RELEASE_NOTIF.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 * It's not mandatory that all the key defined in the notif_key_table be
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162 * notified to the subscriber. If at least one key is set in this table but
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	163 * is not notified to the subscriber, this will have no effect.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	164 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	165 * @param subscriber Subscriber identification value.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166 * @param notif_key_table_p Set of keys for level notification definition.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	167 * @param notif_level Define level of notification is set for all the keys.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	168 * @param long_press_time Time in tenth of seconds before long press time notification (>0).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	169 * @param repeat_time Time in tenth of seconds for key repetition (>0).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	170 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	171 * - RV_OK if operation is successfull
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	172 * - RV_INVALID_PARAMETER if :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	173 * - subscriber identification is incorrect,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	174 * - number of virtual keys is incorrect,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175 * - long_press_time = 0 and repeat_level = KPD_LONG_PRESS_NOTIF or KPD_INFINITE_REPEAT_NOTIF,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	176 * - repeat_time = 0 and repeat_level = KPD_INFINITE_REPEAT_NOTIF.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	177 * - RV_MEMORY_ERR if memory reach its size limit.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	178 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	179 * Message returned: KPD_STATUS_MSG with operation = KPD_REPEAT_KEYS_OP.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180 * Available values for status_value are:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	181 * - KPD_PROCESS_OK if asynchronous operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	182 * - KPD_ERR_KEYS_TABLE if at least one key is not available in the subscriber mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	183 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	184 * @note - Values for long_press_time and repeat_time are available for the subscriber but
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	185 * for all the keys defined in repeat mode. So, if a subscriber call the function
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	186 * twice with different values of long_press_time and repeat_time, only the latest
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	187 * values will be taken into account.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	188 * - If number of notified key is KPD_NB_PHYSICAL_KEYS, client has not to fulfill
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189 * the structure, this will be automatically done by the software entity.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	190 * - If the client set a key to KPD_INFINITE_REPEAT_NOTIF, it will be notified of
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 * the long key pressed and the repeat press.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193 T_RV_RET kpd_define_key_notification(T_KPD_SUBSCRIBER subscriber,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194 T_KPD_VIRTUAL_KEY_TABLE* notif_key_table_p,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195 T_KPD_NOTIF_LEVEL notif_level,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	196 UINT16 long_press_time,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197 UINT16 repeat_time);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	198
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	200 * function: kpd_change_mode
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	202 * This function changes the mode for the specific client.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	203 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204 * @param subscriber Subscriber identification value.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205 * @param notified_keys_p Define all the keys the client want to be notified in the new mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	206 * @param new_mode New mode in which the client want to switch.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	207 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	208 * - RV_OK if operation is successfull
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	209 * - RV_INVALID_PARAMETER if :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	210 * - subscriber identification is incorrect,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	211 * - number of virtual keys is incorrect.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	212 * - RV_MEMORY_ERR if memory reach its size limit.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	213 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	214 * Message returned: KPD_STATUS_MSG with operation = KPD_CHANGE_MODE_OP.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	215 * Available values for status_value are:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	216 * - KPD_PROCESS_OK if asynchronous operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	217 * - KPD_ERR_KEYS_TABLE if at least one key is not available in the new requested mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	218 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	219 * @note - Call to this function cancel, for the subscriber, all the repeat mode defined
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	220 * for the all thekeys with the function kpd_define_repeat_keys.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	221 * - If the subscriber was the owner of the keypad, this privilege is cancelled and
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	222 * keypad is set in multi-notified mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	223 * - If RV_INVALID_PARAMETER is returned, the current mode for the subscriber is
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	224 * the old mode and the subscriber is still the keypad owner if it was.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	225 * - If number of notified key is KPD_NB_PHYSICAL_KEYS, client has not to fulfill
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	226 * the structure, this will be automatically done by the software entity.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	227 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	228 T_RV_RET kpd_change_mode( T_KPD_SUBSCRIBER subscriber,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	229 T_KPD_VIRTUAL_KEY_TABLE* notified_keys_p,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	230 T_KPD_MODE new_mode);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	231
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	232 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	233 * function: kpd_own_keypad
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	234 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	235 * This function allows a subscriber being the only client to be notified by action
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	236 * on keypad (less CPU time used).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	237 * After this call, the keypad is in the "single notified" state.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	238 * This action is cancelled when:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	239 * - The function is called with parameter is_keypad_owner to FALSE,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	240 * - The subscriber (keypad owner) unsubscribe from keypad,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	241 * - The subscriber (keypad owner) changes its mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	242 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	243 * Note that keypad is in the "multi notified" state if there is no subscriber (particularly
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	244 * at the keypad initialisation).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	245 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	246 * @param subscriber Subscriber identification value.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	247 * @param is_keypad_owner Define the state to change.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	248 * TRUE: keypad pass in "single notified" state
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	249 * FALSE: keypad pass in "multi notified" state
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	250 * @param keys_owner_p Set of keys only notified to the subscriber that call this function.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	251 * This is mandatory a subset of the keys defined at subscription.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	252 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	253 * - RV_OK if operation is successfull
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	254 * - RV_INVALID_PARAMETER if :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	255 * - subscriber identification is incorrect,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	256 * - number of virtual keys is incorrect.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	257 * - RV_MEMORY_ERR if memory reach its size limit.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	258 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	259 * Message returned: KPD_STATUS_MSG with operation = KPD_OWN_KEYPAD_OP.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	260 * Available values for status_value are:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	261 * - KPD_PROCESS_OK if asynchronous operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	262 * - KPD_ERR_KEYS_TABLE if at least one key is not defined in the subscriber mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	263 * - KPD_ERR_SN_MODE if keypad driver is already in SN mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	264 * - KPD_ERR_ID_OWNER_KEYPAD if the subscriber try to remove own keypad privilege
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	265 * whereas it is not the keypad owner.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	266 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	267 T_RV_RET kpd_own_keypad( T_KPD_SUBSCRIBER subscriber,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	268 BOOL is_keypad_owner,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	269 T_KPD_VIRTUAL_KEY_TABLE* keys_owner_p);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	270
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	271 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	272 * function: kpd_set_key_config
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	273 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	274 * This function allows setting dynamically a configuration for new or existing virtual keys.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	275 * The two tables define a mapping between each entry (new_keys[1] is mapped with reference_keys[1],
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	276 * new_keys[2] is mapped with reference_keys[2], ...).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	277 * The call of this function doesn't change the mode of the client.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	278 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	279 * @param subscriber Subscriber identification value.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	280 * @param reference_keys_p Set of keys available on keypad in default mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	281 * @param new_keys_p Set of keys which must map with the reference keys.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	282 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	283 * - RV_OK if operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	284 * - RV_INVALID_PARAMETER if :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	285 * - subscriber identification is incorrect,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	286 * - at least one reference key is not defined in the default mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	287 * - number of virtual keys is incorrect (in reference keys or new keys table,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	288 * - RV_NOT_SUPPORTED if configurable mode is not supported.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	289 * - RV_MEMORY_ERR if memory reach its size limit.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	290 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	291 * Message returned: KPD_STATUS_MSG with operation = KPD_SET_CONFIG_MODE_OP.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	292 * Available values for status_value are:
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	293 * - KPD_PROCESS_OK if asynchronous operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	294 * - KPD_ERR_CONFIG_MODE_USED if config mode is used by some subscribers.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	295 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	296 T_RV_RET kpd_set_key_config(T_KPD_SUBSCRIBER subscriber,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	297 T_KPD_VIRTUAL_KEY_TABLE* reference_keys_p,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	298 T_KPD_VIRTUAL_KEY_TABLE* new_keys_p);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	299
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	300 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	301 * function: kpd_get_available_keys
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	302 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	303 * This function allows knowing all the available keys in default mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	304 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	305 * @param available_keys_p Set of keys available on keypad in default mode. The structure
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	306 * must be declared by the caller, and is filled by the function (OUT).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	307 * @return RV_OK.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	308 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	309 T_RV_RET kpd_get_available_keys( T_KPD_VIRTUAL_KEY_TABLE* available_keys_p);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	310
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	311 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	312 * function: kpd_get_ascii_key_code
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	313 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	314 * This function return associated ASCII value to defined key.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	315 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	316 * @param key Key identification value.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	317 * @param mode Mode in which is defined the link between "key" and "ascii code".
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	318 * @param ascii_code Associated ASCII code to parameter "key" (OUT).
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	319 * @return
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	320 * - RV_OK if operation is successfull,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	321 * - RV_INVALID_PARAMETER if :
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	322 * - mode is different of KPD_DEFAULT_MODE or KPD_ALPHANUMERIC_MODE,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	323 * - the key doesn't exist in the defined mode.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	324 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	325 * @note If return value is RV_INVALID_PARAMETER, empty string is set in ascii_code_pp variable.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	326 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	327 T_RV_RET kpd_get_ascii_key_code( T_KPD_VIRTUAL_KEY_ID key,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	328 T_KPD_MODE mode,
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	329 char** ascii_code_pp);
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	330
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	331 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	332 * function: KP_Init
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	333 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	334 * This function is defined for backward compatibility with Condat.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	335 * It register two functions which notify Condat that Power key is long pressed.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	336 * It is used by PWR SWE.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	337 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	338 * @param pressed Callback function to notify that Power key is long pressed.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	339 * @param released Callback function to notify that Power key is released.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	340 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	341 void KP_Init( void(pressed(T_KPD_VIRTUAL_KEY_ID)), void(released(void)) );
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	342
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	343 /@}/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	344
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	345
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	346 /*************************************************************************/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	347 /************************ MESSAGES DEFINITION ************************/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	348 /*************************************************************************/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	349
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	350 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	351 * The message offset must differ for each SWE in order to have
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	352 * unique msg_id in the system.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	353 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	354 #define KPD_MESSAGES_OFFSET (0x36 << 10)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	355
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	356
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	357
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	358 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	359 * @name KPD_KEY_EVENT_MSG
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	360 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	361 * This message is sent to a subscriber when a key is pressed or released.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	362 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	363 * Message issued by KPD to a subscriber.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	364 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	365 /@{/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	366
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	367 /** Definition of the key state (pressed or released). */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	368 typedef UINT8 T_KPD_KEY_STATE;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	369
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	370 /** Definition of the key press state (first press, long press, repeat press). */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	371 typedef UINT8 T_KPD_PRESS_STATE;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	372
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	373
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	374 /** Information sent to a client for a key notification. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	375 typedef struct { T_KPD_VIRTUAL_KEY_ID virtual_key_id;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	376 T_KPD_KEY_STATE state;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	377 T_KPD_PRESS_STATE press_state;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	378 char* ascii_value_p;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	379 } T_KPD_KEY_INFO;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	380
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	381 /** Allowed values for T_KPD_KEY_STATE type. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	382 #define KPD_KEY_PRESSED (0)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	383 /** Allowed values for T_KPD_KEY_STATE type. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	384 #define KPD_KEY_RELEASED (1)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	385
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	386 /** Allowed value for T_KPD_PRESS_STATE type. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	387 #define KPD_FIRST_PRESS (0)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	388 /** Allowed value for T_KPD_PRESS_STATE type. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	389 #define KPD_LONG_PRESS (1)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	390 /** Allowed value for T_KPD_PRESS_STATE type. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	391 #define KPD_REPEAT_PRESS (2)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	392 /** Allowed value for T_KPD_PRESS_STATE type (when state==KPD_KEY_RELEASED). */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	393 #define KPD_INSIGNIFICANT_VALUE (0xff)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	394
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	395 /** Message ID. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	396 #define KPD_KEY_EVENT_MSG (KPD_MESSAGES_OFFSET \| 0x001)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	397
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	398 /** Message structure. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	399 typedef struct
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	400 {
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	401 /** Message header. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	402 T_RV_HDR hdr;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	403
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	404 /** Informations about key event. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	405 T_KPD_KEY_INFO key_info;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	406
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	407 } T_KPD_KEY_EVENT_MSG;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	408 /@}/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	409
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	410
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	411 /**
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	412 * @name KPD_STATUS_MSG
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	413 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	414 * Status message.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	415 *
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	416 * Message issued by KPD to a subscriber.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	417 * This message is used to return the status of an asynchronous process
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	418 * requested by a subscriber.
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	419 */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	420 /@{/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	421
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	422 /* Allowed values for 'operation" field */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	423 #define KPD_SUBSCRIBE_OP 1
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	424 #define KPD_REPEAT_KEYS_OP 2
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	425 #define KPD_CHANGE_MODE_OP 3
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	426 #define KPD_OWN_KEYPAD_OP 4
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	427 #define KPD_SET_CONFIG_MODE_OP 5
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	428
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	429 /* Available values for "status_value" field */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	430 /* This define value is set when asynchronous process is successfull. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	431 #define KPD_PROCESS_OK 1
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	432 /* This define value is set in a status message (KPD_STATUS_MSG) when a client try to
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	433 subscribe whereas keypad is in single-notified mode. Subscription
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	434 is so rejected. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	435 #define KPD_ERR_SN_MODE 2
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	436 /* This defined value is set in a status message (KPD_STATUS_MSG) when a client try to
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	437 modify configuration mode whereas this mode is already used. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	438 #define KPD_ERR_CONFIG_MODE_USED 3
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	439 /* This defined value is set in a status message (KPD_STATUS_MSG) when a client try to
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	440 change keypad state from single-notified to multi-notified whereas it is not
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	441 the keypad owner. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	442 #define KPD_ERR_ID_OWNER_KEYPAD 4
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	443 /* This defined value is set in a status message (KPD_STATUS_MSG) when a client
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	444 defines a key table which is not correct. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	445 #define KPD_ERR_KEYS_TABLE 5
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	446 /* This defined value is set in a status message (KPD_STATUS_MSG) when a client
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	447 try to subscribe to the keypad driver with a return path which is already
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	448 defined by another subscriber. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	449 #define KPD_ERR_RETURN_PATH_EXISTING 6
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	450 /* This defined value is set in a status message (KPD_STATUS_MSG) when an internal
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	451 error cause the failure of the process. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	452 #define KPD_ERR_INTERNAL 7
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	453
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	454
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	455 /** Message ID. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	456 #define KPD_STATUS_MSG (KPD_MESSAGES_OFFSET \| 0x002)
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	457
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	458 /** Message structure. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	459 typedef struct
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	460 {
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	461 /** Message header. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	462 T_RV_HDR hdr;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	463
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	464 /** Operation. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	465 UINT8 operation;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	466
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	467 /** Return status value. */
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	468 UINT8 status_value;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	469
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	470 } T_KPD_STATUS_MSG;
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	471 /@}/
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	472
4e78acac3d88 src/{condat,cs,gpf,nucleus}: import from Selenite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	473 #endif /* #ifndef _KPD_API_H_ */

FreeCalypso > hg > fc-tourmaline

annotate src/cs/drivers/drv_app/kpd/kpd_api.h @ 286:ee16d57b32b2