344de998442d3edca1650718aaf1b39f2f1b28bd
[mw/micromonitor-lm32.git] / umon_main / target / common / genlib.h
1 /* genlib.h:
2  *      Header file for functions in genlib.c (and some others).
3  *
4  *      General notice:
5  *      This code is part of a boot-monitor package developed as a generic base
6  *      platform for embedded system designs.  As such, it is likely to be
7  *      distributed to various projects beyond the control of the original
8  *      author.  Please notify the author of any enhancements made or bugs found
9  *      so that all may benefit from the changes.  In addition, notification back
10  *      to the author will allow the new user to pick up changes that may have
11  *      been made by other users after this version of the code was distributed.
12  *
13  *      Note1: the majority of this code was edited with 4-space tabs.
14  *      Note2: as more and more contributions are accepted, the term "author"
15  *                 is becoming a mis-representation of credit.
16  *
17  *      Original author:        Ed Sutter
18  *      Email:                          esutter@lucent.com
19  *      Phone:                          908-582-2351
20  */
21 #ifndef _GENLIB_H_
22 #define _GENLIB_H_
23
24 #include <stdarg.h>
25
26 /* Some compilers consider sizeof() to be unsigned... */
27 #define sizeof (int)sizeof
28
29 extern int optind;
30 extern char *optarg;
31
32 extern int abs(int);
33 extern int atoi(char *);
34 extern int memcmp(char *, char *, int);
35 extern int strcmp(char *, char *);
36 extern int strcasecmp(char *, char *);
37 extern int strncmp(char *, char *, int);
38 extern int strlen(char *);
39 extern int strspn(char *, char *);
40 extern int strcspn(char *, char *);
41 extern int getopt(int,char **,char *);
42 extern int s_memcpy(char *, char *, int, int, int);
43 extern int s_memset(unsigned char *,unsigned char,int,int,int);
44 extern char *memccpy(char *, char *, int, int);
45 extern char *memchr(char *, char, int);
46 extern char *memcpy(char *, char *, int);
47 extern void bcopy(char *, char *, int);
48 extern char *memset(char *, char, int);
49 extern char *strcat(char *, char *);
50 extern char *strchr(char *, char);
51 extern char *strstr(char *, char *);
52 extern char *strcpy(char *, char *);
53 extern char *strncat(char *, char *, int);
54 extern char *strncpy(char *, char *, int);
55 extern char *strpbrk(char *, char *);
56 extern char *strrchr(char *, char);
57 extern char *strtok(char *, char *);
58 extern char *strtolower(char *string);
59 extern char *strtoupper(char *string);
60 extern long strtol(char *, char **, int);
61 extern unsigned short swap2(unsigned short);
62 extern unsigned long swap4(unsigned long);
63 extern unsigned long strtoul(char *, char **, int);
64 extern void getoptinit(void);
65 extern void prstring(char *);
66 extern void prlong(long);
67 extern long lceil(long n, long to);
68 extern unsigned long ulceil(unsigned long n, unsigned long to);
69
70 /* Included here, but not in genlib.c: */
71 extern int target_gotachar(void), gotachar(void);
72 extern int target_getchar(void), getchar(void);
73 extern int target_putchar(char), putchar(char);
74 extern int target_console_empty(void);
75 extern int AddrToSym(int,unsigned long,char *,unsigned long *);
76 extern int printf(char *, ...);
77 extern int sprintf(char *, char *, ...);
78 extern int snprintf(char *, int, char *, ...);
79 extern int vsnprintf(char *, int, char *, va_list);
80 extern int cprintf(char *, ...);
81 extern int getbytes(char *,int,int);
82 extern int getbytes_t(char *,int,int);
83 extern int putbytes(char *,int);
84 extern int getUsrLvl(void);
85 extern int setenv(char *,char *);
86 extern int shell_sprintf(char *,char *fmt,...);
87 extern int getline(char *,int,int);
88 extern int getline_t(char *,int,int);
89 extern int getline_p(char *,int,int,char *);
90 extern int getfullline(char *buf,int max,int ledit,int timeout,\
91         char *prefill, int echo);
92 extern int stkchk(char *);
93 extern int inRange(char *,int);
94 extern int More(void);
95 extern int validPassword(char *,int);
96 extern int newPasswordFile(void);
97 extern int extValidPassword(char *,int);
98 extern int setCmdUlvl(char *,int);
99 extern int askuser(char *);
100 extern int hitakey(void);
101 extern int getreg(char *,unsigned long *);
102 extern int putreg(char *,unsigned long);
103 extern int putargv(int,char *);
104 extern int addrtosector(unsigned char *,int *,int *,unsigned char **);
105 extern int AppFlashWrite(unsigned char *,unsigned char *,long);
106 extern int AppFlashErase(int);
107 extern int flushDcache(char *,int);
108 extern int invalidateIcache(char *,int);
109 extern int pollConsole(char *);
110 extern int sectortoaddr(int,int *,unsigned char **);
111 extern int sectorProtect(char *,int);
112 extern int FlashInit(void);
113 extern int cacheInit(void);
114 extern int pioget(char,int);
115 extern int extendHeap(char *,int);
116 extern int decompress(char *,int,char *);
117 extern int RedirectionCheck(char *);
118 extern int docommand(char *, int);
119 extern int SymFileFd(int);
120 extern int ShellVarInit(void);
121 extern int showDate(int);
122 extern int inUmonBssSpace(char *,char *);
123 extern int passwordFileExists(void);
124 extern int Mtrace(char *, ...);
125 extern int monWatchDog(void);
126 extern int ConsoleBaudSet(int);
127 extern int ChangeConsoleBaudrate(int);
128 extern int TextInRam(void);
129 extern int uMonInRam(void);
130 extern long portCmd(int, void *);
131 extern unsigned short xcrc16(unsigned char *buffer,unsigned long nbytes);
132 extern unsigned long crc32(unsigned char *,unsigned long);
133 extern unsigned long intsoff(void);
134 extern unsigned long getAppRamStart(void);
135 extern unsigned long assign_handler(long, unsigned long, unsigned long);
136 extern char *line_edit(char *);
137 #ifndef MALLOC_DEBUG
138 extern char *malloc(int);
139 extern char *realloc(char *,int);
140 #endif
141 extern char *getenvp(void);
142 extern char *getenv(char *);
143 extern char *getpass(char *,char *,int,int);
144 extern char *getsym(char *,char *,int);
145 extern char *monVersion(void);
146 extern char *monBuilt(void);
147 extern char *ExceptionType2String(int);
148 extern char *shellsym_chk(char,char *,int *,char *,int);
149 extern void stkusage(void);
150 extern void target_reset(void);
151 extern void flush_console_out(void);
152 extern void flush_console_in(void);
153 extern void initCPUio(void);
154 extern void historyinit(void);
155 extern void AppWarmStart(unsigned long mask);
156 extern void MtraceInit(char *,int);
157 extern void monrestart(int);
158 extern void historylog(char *);
159 extern void free(void *);
160 extern void puts(char *);
161 extern void putstr(char *);
162 extern void MonitorBuiltEnvSet(void);
163 extern void writeprompt(void);
164 extern void intsrestore(unsigned long);
165 extern void prascii(unsigned char *,int);
166 extern void cacheInitForTarget(void);
167 extern void exceptionAutoRestart(int);
168 extern void clrTmpMaxUsrLvl(int (*)(void));
169 extern void *setTmpMaxUsrLvl(void);
170 extern void rawon(void), rawoff(void);
171 extern void monHeader(int);
172 extern void mstatshowcom(void);
173 extern void CommandLoop(void);
174 extern void flushRegtbl(void);
175
176 extern void showregs(void), reginit(void);
177 extern void initUsrLvl(int);
178 extern void warmstart(int);
179 extern void coldstart(void);
180 extern void InitRemoteIO(void);
181 extern void appexit(int);
182 extern void pioset(char,int);
183 extern void pioclr(char,int);
184 extern void getargv(int *argc, char ***argv);
185 extern void init0(void), init1(void), init2(void), init3(void);
186 extern void EnableBreakInterrupt(void);
187 extern void DisableBreakInterrupt(void);
188 extern void     ctxMON(void), ctxAPP(void);
189 extern void printMem(unsigned char *,int,int);
190 extern void monDelay(int);
191 extern void ticktock(void);
192 extern void atinit(void);
193 extern void umonBssInit(void);
194 extern void ConsoleBaudEnvSet(void);
195 extern void console_echo(int);
196 extern void LowerFlashProtectWindow(void);
197 #if INCLUDE_REDIRECT
198 extern void RedirectCharacter(char);
199 extern void RedirectionCmdDone(void);
200 #else
201 #define RedirectCharacter(c)
202 #define RedirectionCmdDone()
203 #endif
204
205 extern unsigned long MonStack[];
206 extern unsigned long crc32tab[];
207 extern unsigned short xcrc16tab[];
208 extern char *Mtracebuf;
209 extern char ApplicationInfo[];
210 extern unsigned long ExceptionAddr, LoopsPerMillisecond;
211 extern unsigned long APPLICATION_RAMSTART, BOOTROM_BASE;
212 extern int ConsoleDevice;
213 extern int ConsoleBaudRate;
214 extern int StateOfMonitor, AppExitStatus, ExceptionType;
215 extern int      bss_start, bss_end, boot_base;
216 extern int  (*remoterawon)(void), (*remoterawoff)(void);
217 extern int  (*remoteputchar)(int), (*remotegetchar)(void);
218 extern int      (*remotegotachar)(void);
219 extern int  (*dcacheFlush)(char *,int), (*icacheInvalidate)(char *,int);
220 extern int      (*extgetUsrLvl)(void);
221 extern int      (*moncomptr)(int,void *, void *, void *);
222
223 #define STACK_PREINIT_VAL       0x63636363
224
225 /* If the watchdog macro is defined, then we also define the
226  * WATCHDOG_ENABLED macro so that code can use #ifdef WATCHDOG_ENABLED
227  * or simply insert WATCHDOG_MACRO inline...
228  * This eliminates the need for the ifdef wrapper if no other code is
229  * included with the macro. 
230  */
231 #ifdef WATCHDOG_MACRO
232 extern int      (*remoteWatchDog)(void);
233 #define WATCHDOG_ENABLED
234 #else
235 #define WATCHDOG_MACRO
236 #endif
237
238 #endif