From: Bert Vermeulen Date: Mon, 10 Jan 2011 12:44:11 +0000 (+0100) Subject: split off prototypes into their own header file X-Git-Tag: libsigrok-0.1.0~453^2~1 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=10509bc2e445b20f90d2ce05561dfbb873180872;p=libsigrok.git split off prototypes into their own header file --- diff --git a/sigrok-proto.h b/sigrok-proto.h new file mode 100644 index 00000000..cbd49a09 --- /dev/null +++ b/sigrok-proto.h @@ -0,0 +1,148 @@ +/* + * This file is part of the sigrok project. + * + * Copyright (C) 2011 Bert Vermeulen + * + * 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 3 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 . + */ + + +#ifndef SIGROK_PROTO_H_ +#define SIGROK_PROTO_H_ + +int filter_probes(int in_unitsize, int out_unitsize, int *probelist, + char *data_in, uint64_t length_in, char **data_out, + uint64_t *length_out); + +char *sigrok_samplerate_string(uint64_t samplerate); +char *sigrok_period_string(uint64_t frequency); + + +/*--- backend.c -------------------------------------------------------------*/ + +int sigrok_init(void); +void sigrok_cleanup(void); + +/*--- debug.c ---------------------------------------------------------------*/ + +void hexdump(unsigned char *address, int length); + +struct input_format **input_list(void); +struct output_format **output_list(void); + +void device_scan(void); +void device_close_all(void); +GSList *device_list(void); +struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes); +void device_clear(struct device *device); +void device_destroy(struct device *dev); + +void device_probe_clear(struct device *device, int probenum); +void device_probe_add(struct device *device, char *name); +struct probe *probe_find(struct device *device, int probenum); +void device_probe_name(struct device *device, int probenum, char *name); + +void device_trigger_clear(struct device *device); +void device_trigger_set(struct device *device, int probenum, char *trigger); + +int load_hwplugins(void); +GSList *list_hwplugins(void); + +/* Generic device instances */ +struct sigrok_device_instance *sigrok_device_instance_new(int index, + int status, const char *vendor, const char *model, const char *version); +struct sigrok_device_instance *get_sigrok_device_instance( + GSList *device_instances, int device_index); +void sigrok_device_instance_free(struct sigrok_device_instance *sdi); + +/* USB-specific instances */ +struct usb_device_instance *usb_device_instance_new(uint8_t bus, + uint8_t address, struct libusb_device_handle *hdl); +void usb_device_instance_free(struct usb_device_instance *usb); + +/* Serial-specific instances */ +struct serial_device_instance *serial_device_instance_new( + const char *port, int fd); +void serial_device_instance_free(struct serial_device_instance *serial); + +int find_hwcap(int *capabilities, int hwcap); +struct hwcap_option *find_hwcap_option(int hwcap); +void source_remove(int fd); +void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb, + void *user_data); + +/*--- session.c -------------------------------------------------------------*/ + +typedef void (*source_callback_remove) (int fd); +typedef void (*source_callback_add) (int fd, int events, int timeout, + receive_data_callback callback, void *user_data); +typedef void (*datafeed_callback) (struct device *device, + struct datafeed_packet *packet); + +/* Session setup */ +struct session *session_load(const char *filename); +struct session *session_new(void); +void session_destroy(void); +void session_device_clear(void); +int session_device_add(struct device *device); + +/* Protocol analyzers setup */ +void session_pa_clear(void); +void session_pa_add(struct analyzer *pa); + +/* Datafeed setup */ +void session_datafeed_callback_clear(void); +void session_datafeed_callback_add(datafeed_callback callback); + +/* Session control */ +int session_start(void); +void session_stop(void); +void session_bus(struct device *device, struct datafeed_packet *packet); +void make_metadata(char *filename); +int session_save(char *filename); + +/*--- hwcommon.c ------------------------------------------------------------*/ + +int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); +int ezusb_install_firmware(libusb_device_handle *hdl, char *filename); +int ezusb_upload_firmware(libusb_device *dev, int configuration, + const char *filename); + +GSList *list_serial_ports(void); +int serial_open(const char *pathname, int flags); +int serial_close(int fd); +int serial_flush(int fd); +void *serial_backup_params(int fd); +void serial_restore_params(int fd, void *backup); +int serial_set_params(int fd, int speed, int bits, int parity, int stopbits, + int flowcontrol); + +/* libsigrok/hardware/common/misc.c */ +/* TODO: Should not be public. */ +int opendev2(int device_index, struct sigrok_device_instance **sdi, + libusb_device *dev, struct libusb_device_descriptor *des, + int *skip, uint16_t vid, uint16_t pid, int interface); +int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev, + struct libusb_device_descriptor *des, + uint16_t vid, uint16_t pid, int interface); + +/*--- datastore.c -----------------------------------------------------------*/ + +int datastore_new(int unitsize, struct datastore **ds); +int datastore_destroy(struct datastore *ds); +void datastore_put(struct datastore *ds, void *data, unsigned int length, + int in_unitsize, int *probelist); + + +#endif /* SIGROK_PROTO_H_ */