3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 1 #ifndef _MMI_BlkResources_H_
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 2 #define _MMI_BlkResources_H_
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 4 #define ALLOC_MEMORY mfwAlloc
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 5 #define FREE_MEMORY mfwFree
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 6
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 7 /*******************************************************************************
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 8
99
+ − 9 CONDAT (UK)
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 10
92
+ − 11 ********************************************************************************
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 12
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 13 This software product is the property of Condat (UK) Ltd and may not be
92
+ − 14 disclosed to any third party without the express permission of the owner.
+ − 15
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 16 ********************************************************************************
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 17
99
+ − 18 $Project name: Basic MMI
+ − 19 $Project code: BMI (6349)
+ − 20 $Module: PhoneBook
+ − 21 $File: MmiBlkResources.h
+ − 22 $Revision: 1.0
92
+ − 23
99
+ − 24 $Author: Condat(UK)
+ − 25 $Date: 25/10/00
92
+ − 26
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 27 ********************************************************************************
92
+ − 28
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 29 Description:
92
+ − 30
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 31 The block resource manager handles a list of blocks of information,
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 32 passing back pointers to the block of data on request. It provides
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 33 a mechanism for mapping identifiers to strings, bitmaps, melodies
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 34 or any other block of information.
92
+ − 35
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 36 ********************************************************************************
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 37
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 38 $History: MmiBlkResources.h
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 39
99
+ − 40 25/10/00 Original Condat(UK) BMI version.
92
+ − 41
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 42 $End
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 43
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 44 *******************************************************************************/
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 45
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 46
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 47 /* Define the prototypes for the basic routines
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 48 */
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 49 typedef void *tBlkHandle;
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 50 typedef long int tBlkId;
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 51
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 52 /* The initialisation routine must be called as part of the startup
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 53 phase of the system, it will allocate working space for the block
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 54 handler if required, and will initialise any structures required
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 55 to maintain the correct operation of the functions. This routine
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 56 must be called prior to invocation of any other block resource
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 57 function
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 58 */
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 59 tBlkHandle mmibr_Initialise( tBlkHandle BlkBase, int NumEntries );
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 60
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 61 /* The shutdown function can be called to free any allocations set up
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 62 by the Initialise routine. In a running system this is unlikely to
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 63 be called unless a catastrophic error has occurred and the system
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 64 needs to be restarted.
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 65 */
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 66 void mmibr_ShutDown( tBlkHandle *BlkRsrc );
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 67
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 68 /* We will adopt a mechanism where each block of data being provided
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 69 will need to be returned to the block resource manager when it
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 70 is no longer being used, this will provide an orthogonal approach
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 71 when dealing with data coming from either ROM or dynamically
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 72 allocated memory
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 73 */
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 74 tBlkHandle mmibr_Fetch( tBlkHandle BlkRsrc, tBlkId Id );
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 75
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 76 /* Added to remove warning Aug - 11 */
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 77 EXTERN U8 *mfwAlloc (U32 size);
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 78 /* End - Remove warning */
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 79
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 80 /*******************************************************************************
92
+ − 81
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 82 End of File
92
+ − 83
3
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 84 *******************************************************************************/
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 85
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
+ − 86 #endif