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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
/*
* dblldefs.h
*
* DSP-BIOS Bridge driver support functions for TI OMAP processors.
*
* Copyright (C) 2005-2006 Texas Instruments, Inc.
*
* This package is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
* WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*/
#ifndef DBLLDEFS_
#define DBLLDEFS_
/*
* Bit masks for dbl_flags.
*/
#define DBLL_NOLOAD 0x0 /* Don't load symbols, code, or data */
#define DBLL_SYMB 0x1 /* load symbols */
#define DBLL_CODE 0x2 /* load code */
#define DBLL_DATA 0x4 /* load data */
#define DBLL_DYNAMIC 0x8 /* dynamic load */
#define DBLL_BSS 0x20 /* Unitialized section */
#define DBLL_MAXPATHLENGTH 255
/*
* ======== DBLL_Target ========
*
*/
struct dbll_tar_obj;
/*
* ======== dbll_flags ========
* Specifies whether to load code, data, or symbols
*/
typedef s32 dbll_flags;
/*
* ======== DBLL_Library ========
*
*/
struct dbll_library_obj;
/*
* ======== dbll_sect_info ========
* For collecting info on overlay sections
*/
struct dbll_sect_info {
const char *name; /* name of section */
u32 sect_run_addr; /* run address of section */
u32 sect_load_addr; /* load address of section */
u32 size; /* size of section (target MAUs) */
dbll_flags type; /* Code, data, or BSS */
};
/*
* ======== dbll_sym_val ========
* (Needed for dynamic load library)
*/
struct dbll_sym_val {
u32 value;
};
/*
* ======== dbll_alloc_fxn ========
* Allocate memory function. Allocate or reserve (if reserved == TRUE)
* "size" bytes of memory from segment "space" and return the address in
* *dsp_address (or starting at *dsp_address if reserve == TRUE). Returns 0 on
* success, or an error code on failure.
*/
typedef s32(*dbll_alloc_fxn) (void *hdl, s32 space, u32 size, u32 align,
u32 *dsp_address, s32 seg_id, s32 req,
bool reserved);
/*
* ======== dbll_close_fxn ========
*/
typedef s32(*dbll_f_close_fxn) (void *);
/*
* ======== dbll_free_fxn ========
* Free memory function. Free, or unreserve (if reserved == TRUE) "size"
* bytes of memory from segment "space"
*/
typedef bool(*dbll_free_fxn) (void *hdl, u32 addr, s32 space, u32 size,
bool reserved);
/*
* ======== dbll_f_open_fxn ========
*/
typedef void *(*dbll_f_open_fxn) (const char *, const char *);
/*
* ======== dbll_log_write_fxn ========
* Function to call when writing data from a section, to log the info.
* Can be NULL if no logging is required.
*/
typedef int(*dbll_log_write_fxn) (void *handle,
struct dbll_sect_info *sect, u32 addr,
u32 bytes);
/*
* ======== dbll_read_fxn ========
*/
typedef s32(*dbll_read_fxn) (void *, size_t, size_t, void *);
/*
* ======== dbll_seek_fxn ========
*/
typedef s32(*dbll_seek_fxn) (void *, long, int);
/*
* ======== dbll_sym_lookup ========
* Symbol lookup function - Find the symbol name and return its value.
*
* Parameters:
* handle - Opaque handle
* parg - Opaque argument.
* name - Name of symbol to lookup.
* sym - Location to store address of symbol structure.
*
* Returns:
* TRUE: Success (symbol was found).
* FALSE: Failed to find symbol.
*/
typedef bool(*dbll_sym_lookup) (void *handle, void *parg, void *rmm_handle,
const char *name, struct dbll_sym_val ** sym);
/*
* ======== dbll_tell_fxn ========
*/
typedef s32(*dbll_tell_fxn) (void *);
/*
* ======== dbll_write_fxn ========
* Write memory function. Write "n" HOST bytes of memory to segment "mtype"
* starting at address "dsp_address" from the buffer "buf". The buffer is
* formatted as an array of words appropriate for the DSP.
*/
typedef s32(*dbll_write_fxn) (void *hdl, u32 dsp_address, void *buf,
u32 n, s32 mtype);
/*
* ======== dbll_attrs ========
*/
struct dbll_attrs {
dbll_alloc_fxn alloc;
dbll_free_fxn free;
void *rmm_handle; /* Handle to pass to alloc, free functions */
dbll_write_fxn write;
void *input_params; /* Handle to pass to write, cinit function */
bool base_image;
dbll_log_write_fxn log_write;
void *log_write_handle;
/* Symbol matching function and handle to pass to it */
dbll_sym_lookup sym_lookup;
void *sym_handle;
void *sym_arg;
/*
* These file manipulation functions should be compatible with the
* "C" run time library functions of the same name.
*/
s32 (*fread)(void *ptr, size_t size, size_t count, void *filp);
s32 (*fseek)(void *filp, long offset, int origin);
s32 (*ftell)(void *filp);
s32 (*fclose)(void *filp);
void *(*fopen)(const char *path, const char *mode);
};
/*
* ======== dbll_close ========
* Close library opened with dbll_open.
* Parameters:
* lib - Handle returned from dbll_open().
* Returns:
* Requires:
* DBL initialized.
* Valid lib.
* Ensures:
*/
typedef void (*dbll_close_fxn) (struct dbll_library_obj *library);
/*
* ======== dbll_create ========
* Create a target object, specifying the alloc, free, and write functions.
* Parameters:
* target_obj - Location to store target handle on output.
* pattrs - Attributes.
* Returns:
* 0: Success.
* -ENOMEM: Memory allocation failed.
* Requires:
* DBL initialized.
* pattrs != NULL.
* target_obj != NULL;
* Ensures:
* Success: *target_obj != NULL.
* Failure: *target_obj == NULL.
*/
typedef int(*dbll_create_fxn) (struct dbll_tar_obj **target_obj,
struct dbll_attrs *attrs);
/*
* ======== dbll_delete ========
* Delete target object and free resources for any loaded libraries.
* Parameters:
* target - Handle returned from DBLL_Create().
* Returns:
* Requires:
* DBL initialized.
* Valid target.
* Ensures:
*/
typedef void (*dbll_delete_fxn) (struct dbll_tar_obj *target);
/*
* ======== dbll_exit ========
* Discontinue use of DBL module.
* Parameters:
* Returns:
* Requires:
* refs > 0.
* Ensures:
* refs >= 0.
*/
typedef void (*dbll_exit_fxn) (void);
/*
* ======== dbll_get_addr ========
* Get address of name in the specified library.
* Parameters:
* lib - Handle returned from dbll_open().
* name - Name of symbol
* sym_val - Location to store symbol address on output.
* Returns:
* TRUE: Success.
* FALSE: Symbol not found.
* Requires:
* DBL initialized.
* Valid library.
* name != NULL.
* sym_val != NULL.
* Ensures:
*/
typedef bool(*dbll_get_addr_fxn) (struct dbll_library_obj *lib, char *name,
struct dbll_sym_val **sym_val);
/*
* ======== dbll_get_attrs ========
* Retrieve the attributes of the target.
* Parameters:
* target - Handle returned from DBLL_Create().
* pattrs - Location to store attributes on output.
* Returns:
* Requires:
* DBL initialized.
* Valid target.
* pattrs != NULL.
* Ensures:
*/
typedef void (*dbll_get_attrs_fxn) (struct dbll_tar_obj *target,
struct dbll_attrs *attrs);
/*
* ======== dbll_get_c_addr ========
* Get address of "C" name on the specified library.
* Parameters:
* lib - Handle returned from dbll_open().
* name - Name of symbol
* sym_val - Location to store symbol address on output.
* Returns:
* TRUE: Success.
* FALSE: Symbol not found.
* Requires:
* DBL initialized.
* Valid target.
* name != NULL.
* sym_val != NULL.
* Ensures:
*/
typedef bool(*dbll_get_c_addr_fxn) (struct dbll_library_obj *lib, char *name,
struct dbll_sym_val **sym_val);
/*
* ======== dbll_get_sect ========
* Get address and size of a named section.
* Parameters:
* lib - Library handle returned from dbll_open().
* name - Name of section.
* paddr - Location to store section address on output.
* psize - Location to store section size on output.
* Returns:
* 0: Success.
* -ENXIO: Section not found.
* Requires:
* DBL initialized.
* Valid lib.
* name != NULL.
* paddr != NULL;
* psize != NULL.
* Ensures:
*/
typedef int(*dbll_get_sect_fxn) (struct dbll_library_obj *lib,
char *name, u32 * addr, u32 * size);
/*
* ======== dbll_init ========
* Initialize DBL module.
* Parameters:
* Returns:
* TRUE: Success.
* FALSE: Failure.
* Requires:
* refs >= 0.
* Ensures:
* Success: refs > 0.
* Failure: refs >= 0.
*/
typedef bool(*dbll_init_fxn) (void);
/*
* ======== dbll_load ========
* Load library onto the target.
*
* Parameters:
* lib - Library handle returned from dbll_open().
* flags - Load code, data and/or symbols.
* attrs - May contain alloc, free, and write function.
* entry_pt - Location to store program entry on output.
* Returns:
* 0: Success.
* -EBADF: File read failed.
* -EILSEQ: Failure in dynamic loader library.
* Requires:
* DBL initialized.
* Valid lib.
* entry != NULL.
* Ensures:
*/
typedef int(*dbll_load_fxn) (struct dbll_library_obj *lib,
dbll_flags flags,
struct dbll_attrs *attrs, u32 *entry);
/*
* ======== dbll_open ========
* dbll_open() returns a library handle that can be used to load/unload
* the symbols/code/data via dbll_load()/dbll_unload().
* Parameters:
* target - Handle returned from dbll_create().
* file - Name of file to open.
* flags - If flags & DBLL_SYMB, load symbols.
* lib_obj - Location to store library handle on output.
* Returns:
* 0: Success.
* -ENOMEM: Memory allocation failure.
* -EBADF: File open/read failure.
* Unable to determine target type.
* Requires:
* DBL initialized.
* Valid target.
* file != NULL.
* lib_obj != NULL.
* dbll_attrs fopen function non-NULL.
* Ensures:
* Success: Valid *lib_obj.
* Failure: *lib_obj == NULL.
*/
typedef int(*dbll_open_fxn) (struct dbll_tar_obj *target, char *file,
dbll_flags flags,
struct dbll_library_obj **lib_obj);
/*
* ======== dbll_read_sect ========
* Read COFF section into a character buffer.
* Parameters:
* lib - Library handle returned from dbll_open().
* name - Name of section.
* pbuf - Buffer to write section contents into.
* size - Buffer size
* Returns:
* 0: Success.
* -ENXIO: Named section does not exists.
* Requires:
* DBL initialized.
* Valid lib.
* name != NULL.
* pbuf != NULL.
* size != 0.
* Ensures:
*/
typedef int(*dbll_read_sect_fxn) (struct dbll_library_obj *lib,
char *name, char *content,
u32 cont_size);
/*
* ======== dbll_unload ========
* Unload library loaded with dbll_load().
* Parameters:
* lib - Handle returned from dbll_open().
* attrs - Contains free() function and handle to pass to it.
* Returns:
* Requires:
* DBL initialized.
* Valid lib.
* Ensures:
*/
typedef void (*dbll_unload_fxn) (struct dbll_library_obj *library,
struct dbll_attrs *attrs);
struct dbll_fxns {
dbll_close_fxn close_fxn;
dbll_create_fxn create_fxn;
dbll_delete_fxn delete_fxn;
dbll_exit_fxn exit_fxn;
dbll_get_attrs_fxn get_attrs_fxn;
dbll_get_addr_fxn get_addr_fxn;
dbll_get_c_addr_fxn get_c_addr_fxn;
dbll_get_sect_fxn get_sect_fxn;
dbll_init_fxn init_fxn;
dbll_load_fxn load_fxn;
dbll_open_fxn open_fxn;
dbll_read_sect_fxn read_sect_fxn;
dbll_unload_fxn unload_fxn;
};
#endif /* DBLDEFS_ */
|