Outline ![]()
Files ![]()
loading...
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/*
* This file is part of the libjaylink project.
*
* Copyright (C) 2015 Marc Schink <jaylink-dev@marcschink.de>
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include "libjaylink.h"
#include "libjaylink-internal.h"
/**
* @file
*
* File I/O functions.
*/
/** @cond PRIVATE */
#define CMD_FILE_IO 0x1e
#define FILE_IO_CMD_READ 0x64
#define FILE_IO_CMD_WRITE 0x65
#define FILE_IO_CMD_GET_SIZE 0x66
#define FILE_IO_CMD_DELETE 0x67
#define FILE_IO_PARAM_FILENAME 0x01
#define FILE_IO_PARAM_OFFSET 0x02
#define FILE_IO_PARAM_LENGTH 0x03
#define FILE_IO_ERR 0x80000000
/** @endcond */
/**
* Read from a file.
*
* The maximum amount of data that can be read from a file at once is
* #JAYLINK_FILE_MAX_TRANSFER_SIZE bytes. Multiple reads in conjunction with
* the @p offset parameter are needed for larger files.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_FILE_IO capability.
*
* @param[in,out] devh Device handle.
* @param[in] filename Name of the file to read from. The length of the name
* must not exceed #JAYLINK_FILE_NAME_MAX_LENGTH bytes.
* @param[out] buffer Buffer to store read data on success. Its content is
* undefined on failure
* @param[in] offset Offset in bytes relative to the beginning of the file from
* where to start reading.
* @param[in,out] length Number of bytes to read. On success, the value gets
* updated with the actual number of bytes read. The
* value is undefined on failure.
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR_DEV Unspecified device error, or the file was not found.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_file_read(struct jaylink_device_handle *devh,
const char *filename, uint8_t *buffer, uint32_t offset,
uint32_t *length)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[18 + JAYLINK_FILE_NAME_MAX_LENGTH];
size_t filename_length;
uint32_t tmp;
if (!devh || !filename || !buffer || !length)
return JAYLINK_ERR_ARG;
if (!*length)
return JAYLINK_ERR_ARG;
if (*length > JAYLINK_FILE_MAX_TRANSFER_SIZE)
return JAYLINK_ERR_ARG;
filename_length = strlen(filename);
if (!filename_length)
return JAYLINK_ERR_ARG;
if (filename_length > JAYLINK_FILE_NAME_MAX_LENGTH)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 18 + filename_length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_FILE_IO;
buf[1] = FILE_IO_CMD_READ;
buf[2] = 0x00;
buf[3] = filename_length;
buf[4] = FILE_IO_PARAM_FILENAME;
memcpy(buf + 5, filename, filename_length);
buf[filename_length + 5] = 0x04;
buf[filename_length + 6] = FILE_IO_PARAM_OFFSET;
buffer_set_u32(buf, offset, filename_length + 7);
buf[filename_length + 11] = 0x04;
buf[filename_length + 12] = FILE_IO_PARAM_LENGTH;
buffer_set_u32(buf, *length, filename_length + 13);
buf[filename_length + 17] = 0x00;
ret = transport_write(devh, buf, 18 + filename_length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_start_read(devh, *length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buffer, *length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_start_read(devh, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
tmp = buffer_get_u32(buf, 0);
if (tmp & FILE_IO_ERR)
return JAYLINK_ERR_DEV;
*length = tmp;
return JAYLINK_OK;
}
/**
* Write to a file.
*
* If a file does not exist, a new file is created.
*
* The maximum amount of data that can be written to a file at once is
* #JAYLINK_FILE_MAX_TRANSFER_SIZE bytes. Multiple writes in conjunction with
* the @p offset parameter are needed for larger files.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_FILE_IO capability.
*
* @param[in,out] devh Device handle.
* @param[in] filename Name of the file to write to. The length of the name
* must not exceed #JAYLINK_FILE_NAME_MAX_LENGTH bytes.
* @param[in] buffer Buffer to write data from.
* @param[in] offset Offset in bytes relative to the beginning of the file from
* where to start writing.
* @param[in,out] length Number of bytes to write. On success, the value gets
* updated with the actual number of bytes written. The
* value is undefined on failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR_DEV Unspecified device error, or the file was not found.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_file_write(struct jaylink_device_handle *devh,
const char *filename, const uint8_t *buffer, uint32_t offset,
uint32_t *length)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[18 + JAYLINK_FILE_NAME_MAX_LENGTH];
size_t filename_length;
uint32_t tmp;
if (!devh || !filename || !buffer || !length)
return JAYLINK_ERR_ARG;
if (!*length)
return JAYLINK_ERR_ARG;
if (*length > JAYLINK_FILE_MAX_TRANSFER_SIZE)
return JAYLINK_ERR_ARG;
filename_length = strlen(filename);
if (!filename_length)
return JAYLINK_ERR_ARG;
if (filename_length > JAYLINK_FILE_NAME_MAX_LENGTH)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 18 + filename_length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_FILE_IO;
buf[1] = FILE_IO_CMD_WRITE;
buf[2] = 0x00;
buf[3] = filename_length;
buf[4] = FILE_IO_PARAM_FILENAME;
memcpy(buf + 5, filename, filename_length);
buf[filename_length + 5] = 0x04;
buf[filename_length + 6] = FILE_IO_PARAM_OFFSET;
buffer_set_u32(buf, offset, filename_length + 7);
buf[filename_length + 11] = 0x04;
buf[filename_length + 12] = FILE_IO_PARAM_LENGTH;
buffer_set_u32(buf, *length, filename_length + 13);
buf[filename_length + 17] = 0x00;
ret = transport_write(devh, buf, 18 + filename_length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_start_write(devh, *length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_write(devh, buffer, *length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_start_read(devh, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
tmp = buffer_get_u32(buf, 0);
if (tmp & FILE_IO_ERR)
return JAYLINK_ERR_DEV;
*length = tmp;
return JAYLINK_OK;
}
/**
* Retrieve the size of a file.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_FILE_IO capability.
*
* @param[in,out] devh Device handle.
* @param[in] filename Name of the file to retrieve the size of. The length
* of the name must not exceed
* #JAYLINK_FILE_NAME_MAX_LENGTH bytes.
* @param[out] size Size of the file in bytes on success, and undefined on
* failure.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR_DEV Unspecified device error, or the file was not found.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_file_get_size(struct jaylink_device_handle *devh,
const char *filename, uint32_t *size)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[6 + JAYLINK_FILE_NAME_MAX_LENGTH];
size_t length;
uint32_t tmp;
if (!devh || !filename || !size)
return JAYLINK_ERR_ARG;
length = strlen(filename);
if (!length)
return JAYLINK_ERR_ARG;
if (length > JAYLINK_FILE_NAME_MAX_LENGTH)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 6 + length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_FILE_IO;
buf[1] = FILE_IO_CMD_GET_SIZE;
buf[2] = 0x00;
buf[3] = length;
buf[4] = FILE_IO_PARAM_FILENAME;
memcpy(buf + 5, filename, length);
buf[length + 5] = 0x00;
ret = transport_write(devh, buf, 6 + length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_start_read(devh, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
tmp = buffer_get_u32(buf, 0);
if (tmp & FILE_IO_ERR)
return JAYLINK_ERR_DEV;
*size = tmp;
return JAYLINK_OK;
}
/**
* Delete a file.
*
* @note This function must only be used if the device has the
* #JAYLINK_DEV_CAP_FILE_IO capability.
*
* @param[in,out] devh Device handle.
* @param[in] filename Name of the file to delete. The length of the name
* must not exceed #JAYLINK_FILE_NAME_MAX_LENGTH bytes.
*
* @retval JAYLINK_OK Success.
* @retval JAYLINK_ERR_ARG Invalid arguments.
* @retval JAYLINK_ERR_TIMEOUT A timeout occurred.
* @retval JAYLINK_ERR_IO Input/output error.
* @retval JAYLINK_ERR_DEV Unspecified device error, or the file was not found.
* @retval JAYLINK_ERR Other error conditions.
*
* @since 0.1.0
*/
JAYLINK_API int jaylink_file_delete(struct jaylink_device_handle *devh,
const char *filename)
{
int ret;
struct jaylink_context *ctx;
uint8_t buf[6 + JAYLINK_FILE_NAME_MAX_LENGTH];
size_t length;
uint32_t tmp;
if (!devh || !filename)
return JAYLINK_ERR_ARG;
length = strlen(filename);
if (!length)
return JAYLINK_ERR_ARG;
if (length > JAYLINK_FILE_NAME_MAX_LENGTH)
return JAYLINK_ERR_ARG;
ctx = devh->dev->ctx;
ret = transport_start_write(devh, 6 + length, true);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
buf[0] = CMD_FILE_IO;
buf[1] = FILE_IO_CMD_DELETE;
buf[2] = 0x00;
buf[3] = length;
buf[4] = FILE_IO_PARAM_FILENAME;
memcpy(buf + 5, filename, length);
buf[length + 5] = 0x00;
ret = transport_write(devh, buf, 6 + length);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_write() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_start_read(devh, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_start_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
ret = transport_read(devh, buf, 4);
if (ret != JAYLINK_OK) {
log_err(ctx, "transport_read() failed: %s",
jaylink_strerror(ret));
return ret;
}
tmp = buffer_get_u32(buf, 0);
if (tmp & FILE_IO_ERR)
return JAYLINK_ERR_DEV;
return JAYLINK_OK;
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
Click anywhere in the source to view detailed information here...