libsigrok
Main Page
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
sigrok.h
Go to the documentation of this file.
1
/*
2
* This file is part of the sigrok project.
3
*
4
* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5
*
6
* This program is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation, either version 3 of the License, or
9
* (at your option) any later version.
10
*
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
15
*
16
* You should have received a copy of the GNU General Public License
17
* along with this program. If not, see <http://www.gnu.org/licenses/>.
18
*/
19
20
#ifndef LIBSIGROK_SIGROK_H
21
#define LIBSIGROK_SIGROK_H
22
23
#include <stdio.h>
24
#include <sys/time.h>
25
#include <stdint.h>
26
#include <inttypes.h>
27
#include <glib.h>
28
29
#ifdef __cplusplus
30
extern
"C"
{
31
#endif
32
33
/*
34
* Package version macros (can be used for conditional compilation).
35
*/
36
37
/** The libsigrok package 'major' version number. */
38
#define SR_PACKAGE_VERSION_MAJOR 0
39
40
/** The libsigrok package 'minor' version number. */
41
#define SR_PACKAGE_VERSION_MINOR 1
42
43
/** The libsigrok package 'micro' version number. */
44
#define SR_PACKAGE_VERSION_MICRO 1
45
46
/** The libsigrok package version ("major.minor.micro") as string. */
47
#define SR_PACKAGE_VERSION_STRING "0.1.1"
48
49
/*
50
* Library/libtool version macros (can be used for conditional compilation).
51
*/
52
53
/** The libsigrok libtool 'current' version number. */
54
#define SR_LIB_VERSION_CURRENT 0
55
56
/** The libsigrok libtool 'revision' version number. */
57
#define SR_LIB_VERSION_REVISION 0
58
59
/** The libsigrok libtool 'age' version number. */
60
#define SR_LIB_VERSION_AGE 0
61
62
/** The libsigrok libtool version ("current:revision:age") as string. */
63
#define SR_LIB_VERSION_STRING "0:0:0"
64
65
/*
66
* Status/error codes returned by libsigrok functions.
67
*
68
* All possible return codes of libsigrok functions must be listed here.
69
* Functions should never return hardcoded numbers as status, but rather
70
* use these #defines instead. All error codes are negative numbers.
71
*
72
* The error codes are globally unique in libsigrok, i.e. if one of the
73
* libsigrok functions returns a "malloc error" it must be exactly the same
74
* return value as used by all other functions to indicate "malloc error".
75
* There must be no functions which indicate two different errors via the
76
* same return code.
77
*
78
* Also, for compatibility reasons, no defined return codes are ever removed
79
* or reused for different #defines later. You can only add new #defines and
80
* return codes, but never remove or redefine existing ones.
81
*/
82
#define SR_OK 0
/* No error */
83
#define SR_ERR -1
/* Generic/unspecified error */
84
#define SR_ERR_MALLOC -2
/* Malloc/calloc/realloc error */
85
#define SR_ERR_ARG -3
/* Function argument error */
86
#define SR_ERR_BUG -4
/* Errors hinting at internal bugs */
87
#define SR_ERR_SAMPLERATE -5
/* Incorrect samplerate */
88
89
#define SR_MAX_NUM_PROBES 64
/* Limited by uint64_t. */
90
#define SR_MAX_PROBENAME_LEN 32
91
92
/* Handy little macros */
93
#define SR_HZ(n) (n)
94
#define SR_KHZ(n) ((n) * 1000)
95
#define SR_MHZ(n) ((n) * 1000000)
96
#define SR_GHZ(n) ((n) * 1000000000)
97
98
#define SR_HZ_TO_NS(n) (1000000000 / (n))
99
100
/* libsigrok loglevels. */
101
#define SR_LOG_NONE 0
/**< Output no messages at all. */
102
#define SR_LOG_ERR 1
/**< Output error messages. */
103
#define SR_LOG_WARN 2
/**< Output warnings. */
104
#define SR_LOG_INFO 3
/**< Output informational messages. */
105
#define SR_LOG_DBG 4
/**< Output debug messages. */
106
#define SR_LOG_SPEW 5
/**< Output very noisy debug messages. */
107
108
/*
109
* Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
110
*
111
* Variables and functions marked 'static' are private already and don't
112
* need SR_PRIV. However, functions which are not static (because they need
113
* to be used in other libsigrok-internal files) but are also not meant to
114
* be part of the public libsigrok API, must use SR_PRIV.
115
*
116
* This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
117
*
118
* This feature is not available on MinGW/Windows, as it is a feature of
119
* ELF files and MinGW/Windows uses PE files.
120
*
121
* Details: http://gcc.gnu.org/wiki/Visibility
122
*/
123
124
/* Marks public libsigrok API symbols. */
125
#ifndef _WIN32
126
#define SR_API __attribute__((visibility("default")))
127
#else
128
#define SR_API
129
#endif
130
131
/* Marks private, non-public libsigrok symbols (not part of the API). */
132
#ifndef _WIN32
133
#define SR_PRIV __attribute__((visibility("hidden")))
134
#else
135
#define SR_PRIV
136
#endif
137
138
typedef
int (*
sr_receive_data_callback_t
)(
int
fd,
int
revents,
void
*cb_data);
139
140
/* Data types used by hardware drivers for dev_config_set() */
141
enum
{
142
SR_T_UINT64
,
143
SR_T_CHAR
,
144
SR_T_BOOL
,
145
};
146
147
/* sr_datafeed_packet.type values */
148
enum
{
149
SR_DF_HEADER
,
150
SR_DF_END
,
151
SR_DF_TRIGGER
,
152
SR_DF_LOGIC
,
153
SR_DF_PD
,
154
};
155
156
struct
sr_datafeed_packet
{
157
uint16_t
type
;
158
void
*
payload
;
159
};
160
161
struct
sr_datafeed_header
{
162
int
feed_version
;
163
struct
timeval
starttime
;
164
uint64_t
samplerate
;
165
int
num_logic_probes
;
166
};
167
168
struct
sr_datafeed_logic
{
169
uint64_t
length
;
170
uint16_t
unitsize
;
171
void
*
data
;
172
};
173
174
struct
sr_input
{
175
struct
sr_input_format
*
format
;
176
char
*
param
;
177
struct
sr_dev
*
vdev
;
178
};
179
180
struct
sr_input_format
{
181
char
*
id
;
182
char
*
description
;
183
int (*
format_match
) (
const
char
*filename);
184
int (*
init
) (
struct
sr_input
*in);
185
int (*
loadfile
) (
struct
sr_input
*in,
const
char
*filename);
186
};
187
188
struct
sr_output
{
189
struct
sr_output_format
*
format
;
190
struct
sr_dev
*
dev
;
191
char
*
param
;
192
void
*
internal
;
193
};
194
195
struct
sr_output_format
{
196
char
*
id
;
197
char
*
description
;
198
int
df_type
;
199
int (*
init
) (
struct
sr_output
*o);
200
int (*
data
) (
struct
sr_output
*o,
const
uint8_t *data_in,
201
uint64_t length_in, uint8_t **data_out,
202
uint64_t *length_out);
203
int (*
event
) (
struct
sr_output
*o,
int
event_type, uint8_t **data_out,
204
uint64_t *length_out);
205
};
206
207
struct
sr_datastore
{
208
/* Size in bytes of the number of units stored in this datastore */
209
int
ds_unitsize
;
210
unsigned
int
num_units
;
/* TODO: uint64_t */
211
GSList *
chunklist
;
212
};
213
214
/*
215
* This represents a generic device connected to the system.
216
* For device-specific information, ask the driver. The driver_index refers
217
* to the device index within that driver; it may be handling more than one
218
* device. All relevant driver calls take a dev_index parameter for this.
219
*/
220
struct
sr_dev
{
221
/* Which driver handles this device */
222
struct
sr_dev_driver
*
driver
;
223
/* A driver may handle multiple devices of the same type */
224
int
driver_index
;
225
/* List of struct sr_probe* */
226
GSList *
probes
;
227
/* Data acquired by this device, if any */
228
struct
sr_datastore
*
datastore
;
229
};
230
231
enum
{
232
SR_PROBE_TYPE_LOGIC
,
233
};
234
235
struct
sr_probe
{
236
int
index
;
237
int
type
;
238
gboolean
enabled
;
239
char
*
name
;
240
char
*
trigger
;
241
};
242
243
/* Hardware driver capabilities */
244
enum
{
245
SR_HWCAP_DUMMY
= 0,
/* Used to terminate lists. Must be 0! */
246
247
/*--- Device classes ------------------------------------------------*/
248
249
/** The device can act as logic analyzer. */
250
SR_HWCAP_LOGIC_ANALYZER
,
251
252
/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
253
254
/*--- Device types --------------------------------------------------*/
255
256
/** The device is demo device. */
257
SR_HWCAP_DEMO_DEV
,
258
259
/*--- Device options ------------------------------------------------*/
260
261
/** The device supports setting/changing its samplerate. */
262
SR_HWCAP_SAMPLERATE
,
263
264
/* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
265
/** The device supports setting a probe mask. */
266
SR_HWCAP_PROBECONFIG
,
267
268
/** The device supports setting a pre/post-trigger capture ratio. */
269
SR_HWCAP_CAPTURE_RATIO
,
270
271
/* TODO? */
272
/** The device supports setting a pattern (pattern generator mode). */
273
SR_HWCAP_PATTERN_MODE
,
274
275
/** The device supports Run Length Encoding. */
276
SR_HWCAP_RLE
,
277
278
/*--- Special stuff -------------------------------------------------*/
279
280
/* TODO: Better description. */
281
/** The device supports specifying a capturefile to inject. */
282
SR_HWCAP_CAPTUREFILE
,
283
284
/* TODO: Better description. */
285
/** The device supports specifying the capturefile unit size. */
286
SR_HWCAP_CAPTURE_UNITSIZE
,
287
288
/* TODO: Better description. */
289
/** The device supports setting the number of probes. */
290
SR_HWCAP_CAPTURE_NUM_PROBES
,
291
292
/*--- Acquisition modes ---------------------------------------------*/
293
294
/**
295
* The device supports setting a sample time limit, i.e. how long the
296
* sample acquisition should run (in ms).
297
*/
298
SR_HWCAP_LIMIT_MSEC
,
299
300
/**
301
* The device supports setting a sample number limit, i.e. how many
302
* samples should be acquired.
303
*/
304
SR_HWCAP_LIMIT_SAMPLES
,
305
306
/**
307
* The device supports continuous sampling, i.e. neither a time limit
308
* nor a sample number limit has to be supplied, it will just acquire
309
* samples continuously, until explicitly stopped by a certain command.
310
*/
311
SR_HWCAP_CONTINUOUS
,
312
313
/* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
314
};
315
316
struct
sr_hwcap_option
{
317
int
hwcap
;
318
int
type
;
319
char
*
description
;
320
char
*
shortname
;
321
};
322
323
struct
sr_dev_inst
{
324
int
index
;
325
int
status
;
326
int
inst_type
;
327
char
*
vendor
;
328
char
*
model
;
329
char
*
version
;
330
void
*
priv
;
331
};
332
333
/* sr_dev_inst types */
334
enum
{
335
/** Device instance type for USB devices. */
336
SR_INST_USB
,
337
/** Device instance type for serial port devices. */
338
SR_INST_SERIAL
,
339
};
340
341
/* Device instance status */
342
enum
{
343
SR_ST_NOT_FOUND
,
344
/* Found, but still booting */
345
SR_ST_INITIALIZING
,
346
/* Live, but not in use */
347
SR_ST_INACTIVE
,
348
/* Actively in use in a session */
349
SR_ST_ACTIVE
,
350
};
351
352
/*
353
* TODO: This sucks, you just kinda have to "know" the returned type.
354
* TODO: Need a DI to return the number of trigger stages supported.
355
*/
356
357
/* Device info IDs */
358
enum
{
359
/* struct sr_dev_inst for this specific device */
360
SR_DI_INST
,
361
/* The number of probes connected to this device */
362
SR_DI_NUM_PROBES
,
363
/* The probe names on this device */
364
SR_DI_PROBE_NAMES
,
365
/* Samplerates supported by this device, (struct sr_samplerates) */
366
SR_DI_SAMPLERATES
,
367
/* Types of trigger supported, out of "01crf" (char *) */
368
SR_DI_TRIGGER_TYPES
,
369
/* The currently set samplerate in Hz (uint64_t) */
370
SR_DI_CUR_SAMPLERATE
,
371
/* Supported patterns (in pattern generator mode) */
372
SR_DI_PATTERNS
,
373
};
374
375
/*
376
* A device supports either a range of samplerates with steps of a given
377
* granularity, or is limited to a set of defined samplerates. Use either
378
* step or list, but not both.
379
*/
380
struct
sr_samplerates
{
381
uint64_t
low
;
382
uint64_t
high
;
383
uint64_t
step
;
384
uint64_t *
list
;
385
};
386
387
struct
sr_dev_driver
{
388
/* Driver-specific */
389
char
*
name
;
390
char
*
longname
;
391
int
api_version
;
392
int (*
init
) (
const
char
*devinfo);
393
int (*
cleanup
) (void);
394
395
/* Device-specific */
396
int (*
dev_open
) (
int
dev_index);
397
int (*
dev_close
) (
int
dev_index);
398
void
*(*dev_info_get) (
int
dev_index,
int
dev_info_id);
399
int (*
dev_status_get
) (
int
dev_index);
400
int
*(*hwcap_get_all) (void);
401
int (*
dev_config_set
) (
int
dev_index,
int
hwcap,
void
*value);
402
int (*
dev_acquisition_start
) (
int
dev_index,
void
*session_dev_id);
403
int (*
dev_acquisition_stop
) (
int
dev_index,
void
*session_dev_id);
404
};
405
406
struct
sr_session
{
407
/* List of struct sr_dev* */
408
GSList *
devs
;
409
/* list of sr_receive_data_callback_t */
410
GSList *
datafeed_callbacks
;
411
GTimeVal
starttime
;
412
gboolean
running
;
413
};
414
415
#include "
sigrok-proto.h
"
416
417
#ifdef __cplusplus
418
}
419
#endif
420
421
#endif
Generated on Wed Mar 27 2013 14:17:41 for libsigrok by
1.8.3.1