fc-magnetite: src/aci2/bmi/mmiUserData.h annotate

annotate src/aci2/bmi/mmiUserData.h @ 632:d968a3216ba0

new tangomdm build target TCS211/Magnetite built for target leonardo runs just fine on the Tango-based Caramel board, but a more proper tangomdm build target is preferable in order to better market these Tango modems to prospective commercial customers. The only differences are in GPIO and MCSI config: * MCSI is enabled in the tangomdm build config. * GPIO 1 is loudspeaker amplifier control on Leonardo, but on Tango platforms it can be used for anything. On Caramel boards this GPIO should be configured as an output driving high. * GPIO 2 needs to be configured as Calypso input on Leonardo, but on Tango platforms it can be used for anything. On Caramel boards this GPIO should be configured as an output, either high or low is OK.

author	Mychaela Falconia <falcon@freecalypso.org>
date	Sat, 04 Jan 2020 19:27:41 +0000
parents	3c2acfa1a72f
children

rev	line source
3 93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 #ifndef _DEF_MMI_USERDATA_H_
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 #define _DEF_MMI_USERDATA_H_
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 /*******************************************************************************
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 CONDAT (UK)
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 ********************************************************************************
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 This software product is the property of Condat (UK) Ltd and may not be
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11 disclosed to any third party without the express permission of the owner.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 ********************************************************************************
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 $Project name: Basic MMI
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 $Project code: BMI (6349)
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 $Module: MMI
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 $File: MmiUserData.h
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 $Revision: 1.0
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 $Author: Condat(UK)
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 $Date: 25/10/00
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24 ********************************************************************************
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26 Description:
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 This provides the root mofule for the basic MMI
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 ********************************************************************************
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 $History: MmiUserData.h
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 $End
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 *******************************************************************************/
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42 #define ALLOC_MEMORY mfwAlloc
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 #define FREE_MEMORY mfwFree
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 /*
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48 * The following enum is the _only_ place where keys for the userData mechanism
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 * can be defined. Everybody _can_ and _must_ define their own keys for
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 * _every_ particular use of userData.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 */
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 typedef enum
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53 {
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 UD_SOFTKEYS,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 UD_OLD_FOCUS,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 UD_SAT_BITS,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 UD_SAT_HANDLE,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58 UD_SAT_KEYBOARD,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59 UD_SAT_MENU,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 UD_SAT_MENU_ATTRIBUTES,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61 UD_SAT_MENU_IDS,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 UD_SAT_MENU_STRINGPOOL,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 UD_SAT_SETUPMENU_COMMAND,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 UD_KBD,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 UD_PARENTWIN,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 UD_MENU
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 } UserKey;
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70 /*
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 * Please note that all functions below come in a userDataHnd... and userDataWin...
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72 * version, which have identical functionality, but get the <window> passed
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 * in MfwHnd or MfwWin pointer form respectively.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74 * You can just use either one depending on what you got hold of at the moment.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 */
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 void userDataHndSet( MfwHnd window, UserKey key, void data);
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 void userDataWinSet( MfwWin window, UserKey key, void *data);
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 /*
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82 * Sets the user data for <window> with <key> to <data>,
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83 * and returns the previous contents of the user data.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 * If <data> itself is returned no user data with <key>
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85 * existed and a new user data element with <key> has been created
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 * and set to <data>.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 * If NULL is returned, either <window> was invalid or a new user data
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 * element could not be created.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 */
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 void *userDataHndGet( MfwHnd window, UserKey key);
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 void userDataWinGet( MfwWin window, UserKey key);
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 /*
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 * Returns the user data for <window> with <key>.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 * If NULL is returned, either <window> was invalid or no user data
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 * with <key> existed.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 */
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102 void *userDataHndDelete( MfwHnd window, UserKey key);
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104 void userDataWinDelete( MfwWin window, UserKey key);
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 /*
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 * Deletes the user data for <window> with <key>, and returns the
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 * contents of the user data.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 * If NULL is returned, either <window> was invalid or no user data
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109 * with <key> existed.
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110 */
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 #endif
93999a60b835 src/aci2, src/condat2: import of g23m/condat source pieces from TCS211 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114

FreeCalypso > hg > fc-magnetite

annotate src/aci2/bmi/mmiUserData.h @ 632:d968a3216ba0