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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
|
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
File: oct6100_user.c
Copyright (c) 2001-2006 Octasic Inc.
Description:
This file contains the functions provided by the user.
This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API is
free software; you can redistribute it and/or modify it under the terms of
the GNU General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later version.
The OCT6100 GPL API is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with the OCT6100 GPL API; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
$Octasic_Release: OCT612xAPI-01.00-PR42 $
$Octasic_Revision: 28 $
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
/***************************** INCLUDE FILES *******************************/
#include "oct6100api/oct6100_apiud.h"
#include "oct6100api/oct6100_errors.h"
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserGetTime
Description: Returns the system time in us.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pTime Pointer to structure in which the time is returned.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserGetTime(
IN OUT tPOCT6100_GET_TIME f_pTime )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserMemSet
Description: Sets f_ulLength bytes pointed to by f_pAddress to f_ulPattern.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pAddress Address in host memory where data should be set.
f_ulPattern Pattern to apply at the address. This value will never
exceed 0xFF.
f_ulLength Length in bytes to set.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserMemSet(
IN PVOID f_pAddress,
IN UINT32 f_ulPattern,
IN UINT32 f_ulLength )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserMemCopy
Description: Copy f_ulLength bytes from f_pSource to f_pDestination.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pDestination Host data destination address.
f_pSource Host data source address.
f_ulLength Length in bytes to copy.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserMemCopy(
IN PVOID f_pDestination,
IN PVOID f_pSource,
IN UINT32 f_ulLength )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserCreateSerializeObject
Description: Creates a serialization object. The serialization object is
seized via the Oct6100UserSeizeSerializeObject function.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pCreate Pointer to structure in which the serialization object's
handle is returned.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserCreateSerializeObject(
IN OUT tPOCT6100_CREATE_SERIALIZE_OBJECT f_pCreate )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDestroySerializeObject
Description: Destroys the indicated serialization object.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pDestroy Pointer to structure containing the handle of the
serialization object.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDestroySerializeObject(
IN tPOCT6100_DESTROY_SERIALIZE_OBJECT f_pDestroy )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserSeizeSerializeObject
Description: Seizes the indicated serialization object.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pSeize Pointer to structure containing the handle of the
serialization object.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserSeizeSerializeObject(
IN tPOCT6100_SEIZE_SERIALIZE_OBJECT f_pSeize )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserReleaseSerializeObject
Description: Releases the indicated serialization object.
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pRelease Pointer to structure containing the handle of the
serialization object.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserReleaseSerializeObject(
IN tPOCT6100_RELEASE_SERIALIZE_OBJECT f_pRelease )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverWriteApi
Description: Performs a write access to the chip. This function is
accessible only from the API code entity (i.e. not from the
APIMI code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pWriteParams Pointer to structure containing the Params to the
write function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverWriteApi(
IN tPOCT6100_WRITE_PARAMS f_pWriteParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverWriteOs
Description: Performs a write access to the chip. This function is
accessible only from the APIMI code entity (i.e. not from the
API code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pWriteParams Pointer to structure containing the Params to the
write function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverWriteOs(
IN tPOCT6100_WRITE_PARAMS f_pWriteParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverWriteSmearApi
Description: Performs a series of write accesses to the chip. The same data
word is written to a series of addresses. The writes begin at
the start address, and the address is incremented by the
indicated amount for each subsequent write. This function is
accessible only from the API code entity (i.e. not from the
APIMI code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pSmearParams Pointer to structure containing the parameters to the
write smear function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverWriteSmearApi(
IN tPOCT6100_WRITE_SMEAR_PARAMS f_pSmearParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverWriteSmearOs
Description: Performs a series of write accesses to the chip. The same data
word is written to a series of addresses. The writes begin at
the start address, and the address is incremented by the
indicated amount for each subsequent write. This function is
accessible only from the APIMI code entity (i.e. not from the
API code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pSmearParams Pointer to structure containing the parameters to the
write smear function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverWriteSmearOs(
IN tPOCT6100_WRITE_SMEAR_PARAMS f_pSmearParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverWriteBurstApi
Description: Performs a series of write accesses to the chip. An array of
data words is written to a series of consecutive addresses.
The writes begin at the start address with element 0 of the
provided array as the data word. The address is incremented by
two for each subsequent write. This function is accessible only
from the API code entity (i.e. not from the APIMI code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pBurstParams Pointer to structure containing the parameters to the
write burst function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverWriteBurstApi(
IN tPOCT6100_WRITE_BURST_PARAMS f_pBurstParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverWriteBurstOs
Description: Performs a series of write accesses to the chip. An array of
data words is written to a series of consecutive addresses.
The writes begin at the start address with element 0 of the
provided array as the data word. The address is incremented by
two for each subsequent write. This function is accessible only
from the API code entity (i.e. not from the APIMI code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pBurstParams Pointer to structure containing the parameters to the
write burst function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverWriteBurstOs(
IN tPOCT6100_WRITE_BURST_PARAMS f_pBurstParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverReadApi
Description: Performs a read access to the chip. This function is accessible
only from the API code entity (i.e. not from the APIMI code
entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pReadParams Pointer to structure containing the parameters to the
read function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverReadApi(
IN OUT tPOCT6100_READ_PARAMS f_pReadParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverReadOs
Description: Performs a read access to the chip. This function is accessible
only from the APIMI code entity (i.e. not from the API code
entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pReadParams Pointer to structure containing the parameters to the
read function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverReadOs(
IN OUT tPOCT6100_READ_PARAMS f_pReadParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverReadBurstApi
Description: Performs a burst of read accesses to the chip. The first read
is performed at the start address, and the address is
incremented by two for each subsequent read. The data is
retunred in an array provided by the user. This function is
accessible only from the API code entity (i.e. not from the
APIMI code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pBurstParams Pointer to structure containing the parameters to the
read burst function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverReadBurstApi(
IN OUT tPOCT6100_READ_BURST_PARAMS f_pBurstParams )
{
return cOCT6100_ERR_OK;
}
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
Function: Oct6100UserDriverReadBurstOs
Description: Performs a burst of read accesses to the chip. The first read
is performed at the start address, and the address is
incremented by two for each subsequent read. The data is
retunred in an array provided by the user. This function is
accessible only from the APIMI code entity (i.e. not from the
API code entity).
-------------------------------------------------------------------------------
| Argument | Description
-------------------------------------------------------------------------------
f_pBurstParams Pointer to structure containing the parameters to the
read burst function.
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
UINT32 Oct6100UserDriverReadBurstOs(
IN OUT tPOCT6100_READ_BURST_PARAMS f_pBurstParams )
{
return cOCT6100_ERR_OK;
}
|