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
|
/*
* nldrdefs.h
*
* DSP-BIOS Bridge driver support functions for TI OMAP processors.
*
* Global Dynamic + static/overlay Node loader (NLDR) constants and types.
*
* Copyright (C) 2008 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 NLDRDEFS_
#define NLDRDEFS_
#include <dspbridge/dbdcddef.h>
#include <dspbridge/devdefs.h>
#define NLDR_MAXPATHLENGTH 255
/* NLDR Objects: */
struct nldr_object;
struct nldr_nodeobject;
/*
* ======== nldr_loadtype ========
* Load types for a node. Must match values in node.h55.
*/
enum nldr_loadtype {
NLDR_STATICLOAD, /* Linked in base image, not overlay */
NLDR_DYNAMICLOAD, /* Dynamically loaded node */
NLDR_OVLYLOAD /* Linked in base image, overlay node */
};
/*
* ======== nldr_ovlyfxn ========
* Causes code or data to be copied from load address to run address. This
* is the "cod_writefxn" that gets passed to the DBLL_Library and is used as
* the ZL write function.
*
* Parameters:
* priv_ref: Handle to identify the node.
* dsp_run_addr: Run address of code or data.
* dsp_load_addr: Load address of code or data.
* ul_num_bytes: Number of (GPP) bytes to copy.
* mem_space: RMS_CODE or RMS_DATA.
* Returns:
* ul_num_bytes: Success.
* 0: Failure.
* Requires:
* Ensures:
*/
typedef u32(*nldr_ovlyfxn) (void *priv_ref, u32 dsp_run_addr,
u32 dsp_load_addr, u32 ul_num_bytes, u32 mem_space);
/*
* ======== nldr_writefxn ========
* Write memory function. Used for dynamic load writes.
* Parameters:
* priv_ref: Handle to identify the node.
* dsp_add: Address of code or data.
* pbuf: Code or data to be written
* ul_num_bytes: Number of (GPP) bytes to write.
* mem_space: DBLL_DATA or DBLL_CODE.
* Returns:
* ul_num_bytes: Success.
* 0: Failure.
* Requires:
* Ensures:
*/
typedef u32(*nldr_writefxn) (void *priv_ref,
u32 dsp_add, void *pbuf,
u32 ul_num_bytes, u32 mem_space);
/*
* ======== nldr_attrs ========
* Attributes passed to nldr_create function.
*/
struct nldr_attrs {
nldr_ovlyfxn pfn_ovly;
nldr_writefxn pfn_write;
u16 us_dsp_word_size;
u16 us_dsp_mau_size;
};
/*
* ======== nldr_phase ========
* Indicates node create, delete, or execute phase function.
*/
enum nldr_phase {
NLDR_CREATE,
NLDR_DELETE,
NLDR_EXECUTE,
NLDR_NOPHASE
};
/*
* Typedefs of loader functions imported from a DLL, or defined in a
* function table.
*/
/*
* ======== nldr_allocate ========
* Allocate resources to manage the loading of a node on the DSP.
*
* Parameters:
* nldr_obj: Handle of loader that will load the node.
* priv_ref: Handle to identify the node.
* node_props: Pointer to a dcd_nodeprops for the node.
* nldr_nodeobj: Location to store node handle on output. This handle
* will be passed to nldr_load/nldr_unload.
* pf_phase_split: pointer to int variable referenced in node.c
* Returns:
* 0: Success.
* -ENOMEM: Insufficient memory on GPP.
* Requires:
* nldr_init(void) called.
* Valid nldr_obj.
* node_props != NULL.
* nldr_nodeobj != NULL.
* Ensures:
* 0: IsValidNode(*nldr_nodeobj).
* error: *nldr_nodeobj == NULL.
*/
typedef int(*nldr_allocatefxn) (struct nldr_object *nldr_obj,
void *priv_ref,
const struct dcd_nodeprops
* node_props,
struct nldr_nodeobject
**nldr_nodeobj,
bool *pf_phase_split);
/*
* ======== nldr_create ========
* Create a loader object. This object handles the loading and unloading of
* create, delete, and execute phase functions of nodes on the DSP target.
*
* Parameters:
* nldr: Location to store loader handle on output.
* hdev_obj: Device for this processor.
* pattrs: Loader attributes.
* Returns:
* 0: Success;
* -ENOMEM: Insufficient memory for requested resources.
* Requires:
* nldr_init(void) called.
* nldr != NULL.
* hdev_obj != NULL.
* pattrs != NULL.
* Ensures:
* 0: Valid *nldr.
* error: *nldr == NULL.
*/
typedef int(*nldr_createfxn) (struct nldr_object **nldr,
struct dev_object *hdev_obj,
const struct nldr_attrs *pattrs);
/*
* ======== nldr_delete ========
* Delete the NLDR loader.
*
* Parameters:
* nldr_obj: Node manager object.
* Returns:
* Requires:
* nldr_init(void) called.
* Valid nldr_obj.
* Ensures:
* nldr_obj invalid
*/
typedef void (*nldr_deletefxn) (struct nldr_object *nldr_obj);
/*
* ======== nldr_exit ========
* Discontinue usage of NLDR module.
*
* Parameters:
* Returns:
* Requires:
* nldr_init(void) successfully called before.
* Ensures:
* Any resources acquired in nldr_init(void) will be freed when last NLDR
* client calls nldr_exit(void).
*/
typedef void (*nldr_exitfxn) (void);
/*
* ======== NLDR_Free ========
* Free resources allocated in nldr_allocate.
*
* Parameters:
* nldr_node_obj: Handle returned from nldr_allocate().
* Returns:
* Requires:
* nldr_init(void) called.
* Valid nldr_node_obj.
* Ensures:
*/
typedef void (*nldr_freefxn) (struct nldr_nodeobject *nldr_node_obj);
/*
* ======== nldr_get_fxn_addr ========
* Get address of create, delete, or execute phase function of a node on
* the DSP.
*
* Parameters:
* nldr_node_obj: Handle returned from nldr_allocate().
* str_fxn: Name of function.
* addr: Location to store function address.
* Returns:
* 0: Success.
* -ESPIPE: Address of function not found.
* Requires:
* nldr_init(void) called.
* Valid nldr_node_obj.
* addr != NULL;
* str_fxn != NULL;
* Ensures:
*/
typedef int(*nldr_getfxnaddrfxn) (struct nldr_nodeobject
* nldr_node_obj,
char *str_fxn, u32 * addr);
/*
* ======== nldr_init ========
* Initialize the NLDR module.
*
* Parameters:
* Returns:
* TRUE if initialization succeeded, FALSE otherwise.
* Ensures:
*/
typedef bool(*nldr_initfxn) (void);
/*
* ======== nldr_load ========
* Load create, delete, or execute phase function of a node on the DSP.
*
* Parameters:
* nldr_node_obj: Handle returned from nldr_allocate().
* phase: Type of function to load (create, delete, or execute).
* Returns:
* 0: Success.
* -ENOMEM: Insufficient memory on GPP.
* -ENXIO: Can't overlay phase because overlay memory
* is already in use.
* -EILSEQ: Failure in dynamic loader library.
* Requires:
* nldr_init(void) called.
* Valid nldr_node_obj.
* Ensures:
*/
typedef int(*nldr_loadfxn) (struct nldr_nodeobject *nldr_node_obj,
enum nldr_phase phase);
/*
* ======== nldr_unload ========
* Unload create, delete, or execute phase function of a node on the DSP.
*
* Parameters:
* nldr_node_obj: Handle returned from nldr_allocate().
* phase: Node function to unload (create, delete, or execute).
* Returns:
* 0: Success.
* -ENOMEM: Insufficient memory on GPP.
* Requires:
* nldr_init(void) called.
* Valid nldr_node_obj.
* Ensures:
*/
typedef int(*nldr_unloadfxn) (struct nldr_nodeobject *nldr_node_obj,
enum nldr_phase phase);
/*
* ======== node_ldr_fxns ========
*/
struct node_ldr_fxns {
nldr_allocatefxn pfn_allocate;
nldr_createfxn pfn_create;
nldr_deletefxn pfn_delete;
nldr_exitfxn pfn_exit;
nldr_getfxnaddrfxn pfn_get_fxn_addr;
nldr_initfxn pfn_init;
nldr_loadfxn pfn_load;
nldr_unloadfxn pfn_unload;
};
#endif /* NLDRDEFS_ */
|
