-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmemsys.h
176 lines (120 loc) · 6.84 KB
/
memsys.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/*
* memsys.h
*
* Created on: Mar 18, 2024
* Author: micahbly
*/
#ifndef MEMORY_SYSTEM_H_
#define MEMORY_SYSTEM_H_
/* about this class: FMMemorySystem
*
* This class holds functions and properties related to viewing and manipulating system memory, including extended memory, on the F256
*
*** things this class needs to be able to do
*
* represent either RAM or Flash memory (read-only in that event)
* scan all memory banks and populate a list of banks
* scan all memory banks and identify KUP programs and mark those banks as executable
* search all memory banks for a given phrase
* perform actions on the selected bank (via child FMBankObjects)
* - clear
* - fill
* - search
* - save to disk
* - populate from disk
* - execute KUP
*
*** things objects of this class have
*
* An array of FMBankObjects (potentially empty)
* flag to indicate RAM vs Flash, R/W vs R
*
*
*/
/*****************************************************************************/
/* Includes */
/*****************************************************************************/
#include "app.h"
#include "bank.h"
/*****************************************************************************/
/* Macro Definitions */
/*****************************************************************************/
#define MEMORY_BANK_COUNT 64 // 64 banks each for RAM and Flash in an F256
#define PARAM_MARK_SELECTED true // param for MemSys_SetBankSelectionByRow
#define PARAM_MARK_UNSELECTED true // param for MemSys_SetBankSelectionByRow
/*****************************************************************************/
/* Enumerations */
/*****************************************************************************/
/*****************************************************************************/
/* Structs */
/*****************************************************************************/
typedef struct FMMemorySystem
{
bool is_flash_; // set to false when representing RAM, not flash.
FMBankObject bank_[MEMORY_BANK_COUNT];
int16_t cur_row_; // 0-n: selected bank num. 0=first bank. -1 if no bank selected.
} FMMemorySystem;
/*****************************************************************************/
/* Global Variables */
/*****************************************************************************/
/*****************************************************************************/
/* Public Function Prototypes */
/*****************************************************************************/
// **** CONSTRUCTOR AND DESTRUCTOR *****
// constructor
// allocates space for the object and any string or other properties that need allocating
// if the passed memsys pointer is not NULL, it will pass it back without allocating a new one.
FMMemorySystem* MemSys_NewOrReset(FMMemorySystem* existing_memsys, bool is_flash);
// destructor
// frees all allocated memory associated with the passed object, and the object itself
void MemSys_Destroy(FMMemorySystem** the_memsys);
// zero every child bank object and have it free any memory associated with it (name, description)
void MemSys_ResetAllBanks(FMMemorySystem* the_memsys);
// **** SETTERS *****
// sets the row num (-1, or 0-n) of the currently selected bank
void MemSys_SetCurrentRow(FMMemorySystem* the_memsys, int16_t the_row_number);
// **** GETTERS *****
// returns the row num (-1, or 0-n) of the currently selected bank
int16_t MemSys_GetCurrentRow(FMMemorySystem* the_memsys);
// // returns the currently selected bank or NULL if no bank selected
// FMBankObject* MemSys_GetCurrentBank(FMMemorySystem* the_memsys);
// returns the currently selected bank's bank_num or 255 if no bank selected
uint8_t MemSys_GetCurrentBankNum(FMMemorySystem* the_memsys);
// gets the KUP-edness of the current bank: true if KUP, false if not a KUP bank or if no current bank selected
// returns false if the bank is not a KUP
bool MemSys_GetCurrentRowKUPState(FMMemorySystem* the_memsys);
// // Returns NULL if nothing matches, or returns pointer to first BankObject with a KUP name that matches exactly
// FMBankObject* MemSys_FindBankByKUPName(FMMemorySystem* the_memsys, char* search_phrase, int compare_len);
// // Returns NULL if nothing matches, or returns pointer to first BankObject with a KUP description that contains the search phrase
// // DOES NOT REQUIRE a match to the full KUP description
// FMBankObject* MemSys_FindBankByKUPDescriptionContains(FMMemorySystem* the_memsys, char* search_phrase, int compare_len);
// // Returns NULL if nothing matches, or returns pointer to first BankObject that contains the search phrase
// // starting_bank_num is the first bank num to start searching in
// // NOTE: does NOT wrap around to bank 0 after hitting bank 63
// FMBankObject* MemSys_FindBankContainingPhrase(FMMemorySystem* the_memsys, char* search_phrase, int compare_len, uint8_t starting_bank_num);
// looks through all banks in the bank list, comparing the passed row to that of each bank.
// Returns NULL if nothing matches, or returns pointer to first matching bank object
FMBankObject* MemSys_FindBankByRow(FMMemorySystem* the_memsys, uint8_t the_row);
// **** OTHER FUNCTIONS *****
// copies the passed bank to the same bank in the target memory system
bool MemSys_CopyBank(FMMemorySystem* the_memsys, FMBankObject* the_bank, FMMemorySystem* the_target_memsys);
// populate the banks in a memory system by scanning EM
void MemSys_PopulateBanks(FMMemorySystem* the_memsys);
// select or unselect 1 bank by row id, and change cur_row_ accordingly
FMBankObject* MemSys_SetBankSelectionByRow(FMMemorySystem* the_memsys, uint16_t the_row, bool do_selection, uint8_t y_offset, bool as_active);
// runs (executes) the program in the current bank, if the bank is a KUP bank
// returns false if the bank is not a KUP
bool MemSys_ExecuteCurrentRow(FMMemorySystem* the_memsys);
// check if user is allowed to clear, copy-to, or fill a chosen bank
bool MemSys_BankIsWriteable(FMMemorySystem* the_memsys);
// **** FILL AND CLEAR FUNCTIONS *****
// ask the user what to fill the current bank with, and fill it with that value
// returns false on any error, or if user escapes out of dialog box without entering a number
bool MemSys_FillCurrentBank(FMMemorySystem* the_memsys);
// fills the current bank with 0s
// returns false on any error
bool MemSys_ClearCurrentBank(FMMemorySystem* the_memsys);
// TEMPORARY DEBUG FUNCTIONS
// // helper function called by List class's print function: prints folder total bytes, and calls print on each file
// void MemSys_Print(void* the_payload);
#endif /* MEMORY_SYSTEM_H_ */