fc-tourmaline: src/ui/bmi/mmiBlkManager.c annotate

annotate src/ui/bmi/mmiBlkManager.c @ 140:1c4536a30e32

mmiBlkManager.c: bogotab fixes

author	Mychaela Falconia <falcon@freecalypso.org>
date	Sat, 14 Nov 2020 04:27:10 +0000
parents	c0052fe355d3
children

rev	line source
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	3 CONDAT (UK)
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	5 ********************************************************************************
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7 This software product is the property of Condat (UK) Ltd and may not be
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	8 disclosed to any third party without the express permission of the owner.
c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	9
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 ********************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	12 $Project name: Basic MMI
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	13 $Project code: BMI (6349)
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	14 $Module: PhoneBook
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	15 $File: MmiBlkManager.c
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	16 $Revision: 1.0
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	17
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	18 $Author: Condat(UK)
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	19 $Date: 25/10/00
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	20
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 ********************************************************************************
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	22
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23 Description:
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25 This module, in conjunction with the MmiBlkResources module,
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	26 provides the access to block resources for the MMI.
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	27
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 The block manager is responsible for creating and initialising
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29 the structures and tables to allow access to the strings, icons
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 sounds and vibrations required by the MMI.
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	31
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32 Each of these items is effectively a contiguous block of memory,
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 which is accessed via a block resource. Each of the block resources
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34 are provided by this package
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36 ********************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38 $History: MmiBlkManager.c
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	40 25/10/00 Original Condat(UK) BMI version.
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	41
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42 $End
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 /*******************************************************************************
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	48
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 Include Files
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	50
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53 #define ENTITY_MFW
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 /* includes */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 #include <string.h>
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 #include <stdio.h>
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58 #include <stdlib.h>
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 #if defined (NEW_FRAME)
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 #include "typedefs.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 #include "vsi.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 #include "pei.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 #include "custom.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 #include "gsm.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 #else
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70 #include "STDDEFS.H"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 #include "custom.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72 #include "gsm.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 #include "vsi.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 #endif
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76 // #include <malloc.h>
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 #include "MmiBlkManager.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 /*******************************************************************************
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	82
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83 Local structures and definitions
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	84
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 /* Define a type for the manager control block, this contains
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 an array identifying each of the resource manager handles
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 which are populated as part of the initialisation sequence
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91 #define BLOCK_MANAGER_KEY 0x00BABE01L
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 #define BLOCK_MANAGER_ENTRY_COUNT 0x00000010L
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 typedef struct _tManagerEntry_
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 {
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	96 tBlkId Id;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	97 int NumEntries;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	98 tBlkHandle EntryBase;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 } tManagerEntry, *pManagerEntry;
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101 typedef struct _tManagerControl_
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102 {
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103 long int BlkKey;
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	104 tBlkHandle BaseAddress;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	105 int BlkLength;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	106 tBlkHandle RsrcList[BLOCK_MANAGER_ENTRY_COUNT];
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	107 pManagerEntry EntryPtr;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 } tManagerControl, *pManagerControl;
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111 /*******************************************************************************
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	112
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 Local routines
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	114
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	119 $Function: ValidManagerResource
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	121 $Description: Determines if the resource indicated by the handle is valid
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	123 $Returns: Zero if failure, non-zero if valid resource
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	125 $Arguments: ManagerRsrc, handle of resource manager
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	126
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 static int ValidManagerResource( tBlkHandle ManagerRsrc )
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 {
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	131 pManagerControl ManagerControl = (pManagerControl) ManagerRsrc;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	133 if ( ManagerControl == NULL )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	134 return 0;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	136 return ( ManagerControl->BlkKey == BLOCK_MANAGER_KEY );
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137 }
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140 /*******************************************************************************
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	141
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 Public routines
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	143
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	149 $Function: mmibm_Initialise
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	151 $Description: Initialise a block manager object
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	153 $Returns: Handle of block manager object, NULL if failure
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	155 $Arguments: BlkBase, base address of the block manager data
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 NumEntries, number of entries to be dealt with by the
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	157 block manager
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	158
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 tBlkHandle mmibm_Initialise( tBlkHandle BlkBase, int NumEntries )
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162 {
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	163 pManagerControl MyControl;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	164 tBlkId Entry;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	165 int i;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	167 if ( ( MyControl = (pManagerControl) ALLOC_MEMORY( sizeof(tManagerControl) ) ) != NULL )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	168 {
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	169 /* Fill in the bits we know are pretty constant
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	170 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	171 MyControl->BlkKey = BLOCK_MANAGER_KEY;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	172 MyControl->BaseAddress = BlkBase;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	173 MyControl->BlkLength = NumEntries;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	174 MyControl->EntryPtr = (pManagerEntry) BlkBase;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	176 /* Initialise the handle array to empty initially
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	177 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	178 for ( i = 0; i < BLOCK_MANAGER_ENTRY_COUNT; i++ )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	179 MyControl->RsrcList[i] = NULL;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	181 /* Now for each entry in the incoming block list we can create
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	182 a handler instance
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	183 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	184 for ( i = 0; i < NumEntries; i++ )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	185 if ( ( Entry = MyControl->EntryPtr[i].Id ) < BLOCK_MANAGER_ENTRY_COUNT )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	186 MyControl->RsrcList[ Entry ] = mmibr_Initialise(
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	187 MyControl->EntryPtr[i].EntryBase, MyControl->EntryPtr[i].NumEntries );
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	188 }
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	190 return MyControl;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 }
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	196 $Function: mmibm_ShutDown
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	198 $Description: Shutdown routine to deallocate resources ina controlled manner
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	200 $Returns: none.
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	202 $Arguments: *BlkHandle, pointer to resource manager handle
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	203
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	206 void mmibm_ShutDown( tBlkHandle *BlkHandle )
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	207 {
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	208 /* Convert and verify the incoming handle
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	209 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	210 pManagerControl MyControl = (pManagerControl) *BlkHandle;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	211 int i;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	212
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	213 if ( ValidManagerResource( *BlkHandle ) )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	214 {
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	215 /* Clear down the allocated resource managers
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	216 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	217 for ( i = 0; i < BLOCK_MANAGER_ENTRY_COUNT; i++ )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	218 if ( MyControl->RsrcList[i] != NULL )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	219 mmibr_ShutDown( &MyControl->RsrcList[i] );
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	220
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	221 /* and free the resource manager handle
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	222 */
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	223 free( *BlkHandle );
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	224 *BlkHandle = NULL;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	225 }
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	226 }
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	227
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	228
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	229 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	230
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	231 $Function: mmibm_SupplyResourceHandler
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	232
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	233 $Description:
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	234
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	235 Since this module will be managing each of the block handlers
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	236 for each of the resources, we need to be able to supply the
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	237 appropriate handle for any given type to the calling routine.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	238
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	239 $Returns: Handle to requesteb block resource handler, NULL if failure
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	240
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	241 $Arguments: ManagerHandle, handle of the block manager
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	242 Id, identifier of the resource table for which the resource
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	243 handler is required
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	244
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	245 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	246
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	247 tBlkHandle mmibm_SupplyResourceHandler( tBlkHandle ManagerHandle, tBlkId Id )
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	248 {
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	249 /* Convert and verify the incoming handle
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	250 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	251 pManagerControl MyControl = (pManagerControl) ManagerHandle;
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	252 if ( ! ValidManagerResource( ManagerHandle ) )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	253 return NULL;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	254
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	255 /* Verify the id is within the range we expect
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	256 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	257 if ( ( Id >= 0 ) && ( Id < BLOCK_MANAGER_ENTRY_COUNT ) )
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	258 return MyControl->RsrcList[Id];
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	259
140 1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	260 /* Okay, we have something invalid, so return NULL
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	261 */
1c4536a30e32 mmiBlkManager.c: bogotab fixes Mychaela Falconia <falcon@freecalypso.org> parents: 92 diff changeset	262 return NULL;
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	263 }
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	264
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	265
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	266
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	267 /*******************************************************************************
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	268
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	269 End of File
92 c0052fe355d3 src/ui/bmi/.[ch]: rm trailing white space Mychaela Falconia <falcon@freecalypso.org>* parents: 3 diff changeset	270
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	271 *******************************************************************************/

FreeCalypso > hg > fc-tourmaline

annotate src/ui/bmi/mmiBlkManager.c @ 140:1c4536a30e32