Debian Codegraph @

xpp/oct612x/octdeviceapi/oct6100api/oct6100_api/oct6100_user.c

raw
1 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
3 File: oct6100_user.c
4
5 Copyright (c) 2001-2007 Octasic Inc.
6
7 Description:
8
9 This file contains the functions provided by the user.
10
11 This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API is
12 free software; you can redistribute it and/or modify it under the terms of
13 the GNU General Public License as published by the Free Software Foundation;
14 either version 2 of the License, or (at your option) any later version.
15
16 The OCT6100 GPL API is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
18 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with the OCT6100 GPL API; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24
25 $Octasic_Release: OCT612xAPI-01.00-PR49 $
26
27 $Octasic_Revision: 28 $
28
29 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
30
31
32 /***************************** INCLUDE FILES *******************************/
33
34
35 #include "oct6100api/oct6100_apiud.h"
36 #include "oct6100api/oct6100_errors.h"
37
38
39
40 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
41
42 Function: Oct6100UserGetTime
43
44 Description: Returns the system time in us.
45
46 -------------------------------------------------------------------------------
47 | Argument | Description
48 -------------------------------------------------------------------------------
49 f_pTime Pointer to structure in which the time is returned.
50
51 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
52 #if !SKIP_Oct6100UserGetTime
53 UINT32 Oct6100UserGetTime(
54 IN OUT tPOCT6100_GET_TIME f_pTime )
55 {
56
57 return cOCT6100_ERR_OK;
58 }
59 #endif
60
61
62
63
64
65 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
66
67 Function: Oct6100UserMemSet
68
69 Description: Sets f_ulLength bytes pointed to by f_pAddress to f_ulPattern.
70
71 -------------------------------------------------------------------------------
72 | Argument | Description
73 -------------------------------------------------------------------------------
74
75 f_pAddress Address in host memory where data should be set.
76 f_ulPattern Pattern to apply at the address. This value will never
77 exceed 0xFF.
78 f_ulLength Length in bytes to set.
79
80 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
81 #if !SKIP_Oct6100UserMemSet
82 UINT32 Oct6100UserMemSet(
83 IN PVOID f_pAddress,
84 IN UINT32 f_ulPattern,
85 IN UINT32 f_ulLength )
86 {
87
88 return cOCT6100_ERR_OK;
89 }
90 #endif
91
92
93 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
94
95 Function: Oct6100UserMemCopy
96
97 Description: Copy f_ulLength bytes from f_pSource to f_pDestination.
98
99 -------------------------------------------------------------------------------
100 | Argument | Description
101 -------------------------------------------------------------------------------
102
103 f_pDestination Host data destination address.
104 f_pSource Host data source address.
105 f_ulLength Length in bytes to copy.
106
107 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
108 #if !SKIP_Oct6100UserMemCopy
109 UINT32 Oct6100UserMemCopy(
110 IN PVOID f_pDestination,
111 IN const void *f_pSource,
112 IN UINT32 f_ulLength )
113 {
114
115 return cOCT6100_ERR_OK;
116 }
117 #endif
118
119
120 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
121
122 Function: Oct6100UserCreateSerializeObject
123
124 Description: Creates a serialization object. The serialization object is
125 seized via the Oct6100UserSeizeSerializeObject function.
126
127 -------------------------------------------------------------------------------
128 | Argument | Description
129 -------------------------------------------------------------------------------
130 f_pCreate Pointer to structure in which the serialization object's
131 handle is returned.
132
133 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
134 #if !SKIP_Oct6100UserCreateSerializeObject
135 UINT32 Oct6100UserCreateSerializeObject(
136 IN OUT tPOCT6100_CREATE_SERIALIZE_OBJECT f_pCreate )
137 {
138
139
140 return cOCT6100_ERR_OK;
141 }
142 #endif
143
144
145 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
146
147 Function: Oct6100UserDestroySerializeObject
148
149 Description: Destroys the indicated serialization object.
150
151 -------------------------------------------------------------------------------
152 | Argument | Description
153 -------------------------------------------------------------------------------
154 f_pDestroy Pointer to structure containing the handle of the
155 serialization object.
156
157 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
158 #if !SKIP_Oct6100UserDestroySerializeObject
159 UINT32 Oct6100UserDestroySerializeObject(
160 IN tPOCT6100_DESTROY_SERIALIZE_OBJECT f_pDestroy )
161 {
162
163
164 return cOCT6100_ERR_OK;
165 }
166 #endif
167
168
169 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
170
171 Function: Oct6100UserSeizeSerializeObject
172
173 Description: Seizes the indicated serialization object.
174
175 -------------------------------------------------------------------------------
176 | Argument | Description
177 -------------------------------------------------------------------------------
178 f_pSeize Pointer to structure containing the handle of the
179 serialization object.
180
181 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
182 #if !SKIP_Oct6100UserSeizeSerializeObject
183 UINT32 Oct6100UserSeizeSerializeObject(
184 IN tPOCT6100_SEIZE_SERIALIZE_OBJECT f_pSeize )
185 {
186
187
188 return cOCT6100_ERR_OK;
189 }
190 #endif
191
192
193 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
194
195 Function: Oct6100UserReleaseSerializeObject
196
197 Description: Releases the indicated serialization object.
198
199 -------------------------------------------------------------------------------
200 | Argument | Description
201 -------------------------------------------------------------------------------
202 f_pRelease Pointer to structure containing the handle of the
203 serialization object.
204
205 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
206 #if !SKIP_Oct6100UserReleaseSerializeObject
207 UINT32 Oct6100UserReleaseSerializeObject(
208 IN tPOCT6100_RELEASE_SERIALIZE_OBJECT f_pRelease )
209 {
210
211
212 return cOCT6100_ERR_OK;
213 }
214 #endif
215
216
217 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
218
219 Function: Oct6100UserDriverWriteApi
220
221 Description: Performs a write access to the chip. This function is
222 accessible only from the API code entity (i.e. not from the
223 APIMI code entity).
224
225 -------------------------------------------------------------------------------
226 | Argument | Description
227 -------------------------------------------------------------------------------
228 f_pWriteParams Pointer to structure containing the Params to the
229 write function.
230
231 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
232 #if !SKIP_Oct6100UserDriverWriteApi
233 UINT32 Oct6100UserDriverWriteApi(
234 IN tPOCT6100_WRITE_PARAMS f_pWriteParams )
235 {
236
237
238
239
240 return cOCT6100_ERR_OK;
241 }
242 #endif
243
244
245 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
246
247 Function: Oct6100UserDriverWriteOs
248
249 Description: Performs a write access to the chip. This function is
250 accessible only from the APIMI code entity (i.e. not from the
251 API code entity).
252
253 -------------------------------------------------------------------------------
254 | Argument | Description
255 -------------------------------------------------------------------------------
256 f_pWriteParams Pointer to structure containing the Params to the
257 write function.
258
259 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
260 #if !SKIP_Oct6100UserDriverWriteOs
261 UINT32 Oct6100UserDriverWriteOs(
262 IN tPOCT6100_WRITE_PARAMS f_pWriteParams )
263 {
264
265 return cOCT6100_ERR_OK;
266 }
267 #endif
268
269
270 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
271
272 Function: Oct6100UserDriverWriteSmearApi
273
274 Description: Performs a series of write accesses to the chip. The same data
275 word is written to a series of addresses. The writes begin at
276 the start address, and the address is incremented by the
277 indicated amount for each subsequent write. This function is
278 accessible only from the API code entity (i.e. not from the
279 APIMI code entity).
280
281 -------------------------------------------------------------------------------
282 | Argument | Description
283 -------------------------------------------------------------------------------
284 f_pSmearParams Pointer to structure containing the parameters to the
285 write smear function.
286
287 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
288 #if !SKIP_Oct6100UserDriverWriteSmearApi
289 UINT32 Oct6100UserDriverWriteSmearApi(
290 IN tPOCT6100_WRITE_SMEAR_PARAMS f_pSmearParams )
291 {
292
293
294
295
296 return cOCT6100_ERR_OK;
297 }
298 #endif
299
300
301 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
302
303 Function: Oct6100UserDriverWriteSmearOs
304
305 Description: Performs a series of write accesses to the chip. The same data
306 word is written to a series of addresses. The writes begin at
307 the start address, and the address is incremented by the
308 indicated amount for each subsequent write. This function is
309 accessible only from the APIMI code entity (i.e. not from the
310 API code entity).
311
312 -------------------------------------------------------------------------------
313 | Argument | Description
314 -------------------------------------------------------------------------------
315 f_pSmearParams Pointer to structure containing the parameters to the
316 write smear function.
317
318 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
319 #if !SKIP_Oct6100UserDriverWriteSmearOs
320 UINT32 Oct6100UserDriverWriteSmearOs(
321 IN tPOCT6100_WRITE_SMEAR_PARAMS f_pSmearParams )
322 {
323
324
325 return cOCT6100_ERR_OK;
326 }
327 #endif
328
329
330 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
331
332 Function: Oct6100UserDriverWriteBurstApi
333
334 Description: Performs a series of write accesses to the chip. An array of
335 data words is written to a series of consecutive addresses.
336 The writes begin at the start address with element 0 of the
337 provided array as the data word. The address is incremented by
338 two for each subsequent write. This function is accessible only
339 from the API code entity (i.e. not from the APIMI code entity).
340
341 -------------------------------------------------------------------------------
342 | Argument | Description
343 -------------------------------------------------------------------------------
344 f_pBurstParams Pointer to structure containing the parameters to the
345 write burst function.
346
347 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
348 #if !SKIP_Oct6100UserDriverWriteBurstApi
349 UINT32 Oct6100UserDriverWriteBurstApi(
350 IN tPOCT6100_WRITE_BURST_PARAMS f_pBurstParams )
351 {
352
353
354
355
356 return cOCT6100_ERR_OK;
357 }
358 #endif
359
360
361 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
362
363 Function: Oct6100UserDriverWriteBurstOs
364
365 Description: Performs a series of write accesses to the chip. An array of
366 data words is written to a series of consecutive addresses.
367 The writes begin at the start address with element 0 of the
368 provided array as the data word. The address is incremented by
369 two for each subsequent write. This function is accessible only
370 from the API code entity (i.e. not from the APIMI code entity).
371
372 -------------------------------------------------------------------------------
373 | Argument | Description
374 -------------------------------------------------------------------------------
375 f_pBurstParams Pointer to structure containing the parameters to the
376 write burst function.
377
378 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
379 #if !SKIP_Oct6100UserDriverWriteBurstOs
380 UINT32 Oct6100UserDriverWriteBurstOs(
381 IN tPOCT6100_WRITE_BURST_PARAMS f_pBurstParams )
382 {
383
384
385 return cOCT6100_ERR_OK;
386 }
387 #endif
388
389
390 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
391
392 Function: Oct6100UserDriverReadApi
393
394 Description: Performs a read access to the chip. This function is accessible
395 only from the API code entity (i.e. not from the APIMI code
396 entity).
397
398 -------------------------------------------------------------------------------
399 | Argument | Description
400 -------------------------------------------------------------------------------
401 f_pReadParams Pointer to structure containing the parameters to the
402 read function.
403
404 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
405 #if !SKIP_Oct6100UserDriverReadApi
406 UINT32 Oct6100UserDriverReadApi(
407 IN OUT tPOCT6100_READ_PARAMS f_pReadParams )
408 {
409
410
411
412
413 return cOCT6100_ERR_OK;
414 }
415 #endif
416
417
418 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
419
420 Function: Oct6100UserDriverReadOs
421
422 Description: Performs a read access to the chip. This function is accessible
423 only from the APIMI code entity (i.e. not from the API code
424 entity).
425
426 -------------------------------------------------------------------------------
427 | Argument | Description
428 -------------------------------------------------------------------------------
429 f_pReadParams Pointer to structure containing the parameters to the
430 read function.
431
432 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
433 #if !SKIP_Oct6100UserDriverReadOs
434 UINT32 Oct6100UserDriverReadOs(
435 IN OUT tPOCT6100_READ_PARAMS f_pReadParams )
436 {
437
438
439 return cOCT6100_ERR_OK;
440 }
441 #endif
442
443
444 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
445
446 Function: Oct6100UserDriverReadBurstApi
447
448 Description: Performs a burst of read accesses to the chip. The first read
449 is performed at the start address, and the address is
450 incremented by two for each subsequent read. The data is
451 retunred in an array provided by the user. This function is
452 accessible only from the API code entity (i.e. not from the
453 APIMI code entity).
454
455 -------------------------------------------------------------------------------
456 | Argument | Description
457 -------------------------------------------------------------------------------
458 f_pBurstParams Pointer to structure containing the parameters to the
459 read burst function.
460
461 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
462 #if !SKIP_Oct6100UserDriverReadBurstApi
463 UINT32 Oct6100UserDriverReadBurstApi(
464 IN OUT tPOCT6100_READ_BURST_PARAMS f_pBurstParams )
465 {
466
467
468
469
470 return cOCT6100_ERR_OK;
471 }
472 #endif
473
474
475 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
476
477 Function: Oct6100UserDriverReadBurstOs
478
479 Description: Performs a burst of read accesses to the chip. The first read
480 is performed at the start address, and the address is
481 incremented by two for each subsequent read. The data is
482 retunred in an array provided by the user. This function is
483 accessible only from the APIMI code entity (i.e. not from the
484 API code entity).
485
486 -------------------------------------------------------------------------------
487 | Argument | Description
488 -------------------------------------------------------------------------------
489 f_pBurstParams Pointer to structure containing the parameters to the
490 read burst function.
491
492 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
493 #if !SKIP_Oct6100UserDriverReadBurstOs
494 UINT32 Oct6100UserDriverReadBurstOs(
495 IN OUT tPOCT6100_READ_BURST_PARAMS f_pBurstParams )
496 {
497
498
499 return cOCT6100_ERR_OK;
500 }
501 #endif
502
503
504
505
506
507
508