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
|
<html>
<head>
<title>Header File Index</title>
<link rel="STYLESHEET" type="TEXT/CSS" href="style.css">
</head>
<body bgcolor="#fffff8">
<table class="INVTABLE" width="100%">
<tbody>
<tr>
<td class="NOBORDER" width="40"><img src="info.gif" border="0"
height="32" width="32"> </td>
<td class="TITLE">Entry Points
<br>
</td>
</tr>
</tbody>
</table>
<hr>
<h3><a name="ticables_library_init"></a>ticables_library_init</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_library_init(void)
</td>
</tr>
</tbody>
</table>
<br>
This function must be the first one to call. It inits library internals.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">the instance count.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_library_exit"></a>ticables_library_exit</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_library_exit(void)
</td>
</tr>
</tbody>
</table>
<br>
This function must be the last one to call. Used to release internal resources.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">the instance count.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_version_get"></a>ticables_version_get</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 const char *TICALL ticables_version_get(void)
</td>
</tr>
</tbody>
</table>
<br>
This function returns the library version like "X.Y.Z".
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">a string.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_supported_cables"></a>ticables_supported_cables</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 uint32_t TICALL ticables_supported_cables (void)
</td>
</tr>
</tbody>
</table>
<br>
This function returns the cables built into the current binary.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">an integer containing a binary OR of (1 << CABLE_*) values,
where CABLE_* values are defined in enum CableModel.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_handle_new"></a>ticables_handle_new</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 CableHandle* TICALL ticables_handle_new(CableModel model, CablePort port)
</td>
</tr>
</tbody>
</table>
<br>
Create a new handle associated with the given cable on the given port.
Must be freed with ticables_handle_del when no longer needed.
Note: the handle is a pointer on an opaque structure and should not be modified.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">model :<br></td>
<td style="vertical-align: top;">a cable model
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">port :<br></td>
<td style="vertical-align: top;">the generic port on which cable is attached.
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">NULL if error, an handle otherwise.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_handle_del"></a>ticables_handle_del</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_handle_del(CableHandle* handle)
</td>
</tr>
</tbody>
</table>
<br>
Release the cable and free the associated resources.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">always 0.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_options_set_timeout"></a>ticables_options_set_timeout</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 unsigned int TICALL ticables_options_set_timeout(CableHandle* handle, unsigned int timeout)
</td>
</tr>
</tbody>
</table>
<br>
Set timeout for any cable.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">timeout :<br></td>
<td style="vertical-align: top;">timeout value in tenth of seconds
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">the previous timeout.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_options_set_delay"></a>ticables_options_set_delay</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 unsigned int TICALL ticables_options_set_delay(CableHandle* handle, unsigned int delay)
</td>
</tr>
</tbody>
</table>
<br>
Set inter-bit delay for parallel or BlackLink cable.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">delay :<br></td>
<td style="vertical-align: top;">delay in micro-seconds
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">the previous delay.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_get_model"></a>ticables_get_model</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 CableModel TICALL ticables_get_model(CableHandle* handle)
</td>
</tr>
</tbody>
</table>
<br>
Retrieve link cable model.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">the previous #CableModel value.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_get_port"></a>ticables_get_port</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 CablePort TICALL ticables_get_port(CableHandle* handle)
</td>
</tr>
</tbody>
</table>
<br>
Retrieve link port.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">a #CablePort value.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_get_device"></a>ticables_get_device</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 const char * TICALL ticables_get_device(CableHandle* handle)
</td>
</tr>
</tbody>
</table>
<br>
Retrieve device port.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">a char pointer.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_get_timeout"></a>ticables_get_timeout</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 unsigned int TICALL ticables_get_timeout(CableHandle *handle)
</td>
</tr>
</tbody>
</table>
<br>
Retrieve timeout.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">an unsigned integer;
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_get_delay"></a>ticables_get_delay</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 unsigned int TICALL ticables_get_delay(CableHandle *handle)
</td>
</tr>
</tbody>
</table>
<br>
Retrieve timeout.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">an unsigned integer;
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a name="ticables_handle_show"></a>ticables_handle_show</h3>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">TIEXPORT1 int TICALL ticables_handle_show(CableHandle* handle)
</td>
</tr>
</tbody>
</table>
<br>
Show information stored in the handle.
<br>
<br>
<table style="width: 100%; text-align: left;" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td style="vertical-align: top;">handle :<br></td>
<td style="vertical-align: top;">the handle
<br></td>
</tr>
<tr>
<td style="vertical-align: top;">Return value :<br></td>
<td style="vertical-align: top;">always 0.
<br></td>
</tr>
</tbody>
</table>
<br>
<h3><a href="file:index.html">Return to the main index</a> </h3><br><br><br></body>
</html>
|
