/* * This file is part of the sigrok project. * * Copyright (C) 2010-2012 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 . */ #include #include #include #include #include #include #include "libsigrok.h" #include "libsigrok-internal.h" /* Driver scanning options. */ SR_API struct sr_hwcap_option sr_drvopts[] = { {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"}, {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"}, {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"}, {0, 0, NULL, NULL}, }; /* Device instance options. */ SR_API struct sr_hwcap_option sr_hwcap_options[] = { {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"}, {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"}, {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"}, {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"}, {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"}, {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"}, {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position", "horiz_triggerpos"}, {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"}, {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"}, {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"}, {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"}, {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"}, {0, 0, NULL, NULL}, }; #ifdef HAVE_LA_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif #ifdef HAVE_LA_OLS extern SR_PRIV struct sr_dev_driver ols_driver_info; #endif #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; #endif #ifdef HAVE_LA_ASIX_SIGMA extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; #endif #ifdef HAVE_LA_CHRONOVU_LA8 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; #endif #ifdef HAVE_LA_LINK_MSO19 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; #endif #ifdef HAVE_LA_ALSA extern SR_PRIV struct sr_dev_driver alsa_driver_info; #endif #ifdef HAVE_LA_FX2LAFW extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; #endif #ifdef HAVE_HW_HANTEK_DSO extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; #endif #ifdef HAVE_HW_GENERICDMM extern SR_PRIV struct sr_dev_driver genericdmm_driver_info; #endif static struct sr_dev_driver *drivers_list[] = { #ifdef HAVE_LA_DEMO &demo_driver_info, #endif #ifdef HAVE_LA_OLS &ols_driver_info, #endif #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE &zeroplus_logic_cube_driver_info, #endif #ifdef HAVE_LA_ASIX_SIGMA &asix_sigma_driver_info, #endif #ifdef HAVE_LA_CHRONOVU_LA8 &chronovu_la8_driver_info, #endif #ifdef HAVE_LA_LINK_MSO19 &link_mso19_driver_info, #endif #ifdef HAVE_LA_ALSA &alsa_driver_info, #endif #ifdef HAVE_LA_FX2LAFW &fx2lafw_driver_info, #endif #ifdef HAVE_HW_HANTEK_DSO &hantek_dso_driver_info, #endif #ifdef HAVE_HW_GENERICDMM &genericdmm_driver_info, #endif NULL, }; /** * Return the list of supported hardware drivers. * * @return Pointer to the NULL-terminated list of hardware driver pointers. */ SR_API struct sr_dev_driver **sr_driver_list(void) { return drivers_list; } /** * Initialize a hardware driver. * * @param driver The driver to initialize. * * @return SR_OK if all went well, or an error code otherwise. */ SR_API int sr_driver_init(struct sr_dev_driver *driver) { if (driver->init) return driver->init(); return SR_OK; } /** * Tell a hardware driver to scan for devices. * * @param driver The driver. * @param options A list of struct sr_hwopt options to pass to the driver's * scanner. * * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found. * This list must be freed by the caller, but without freeing the data * pointed to in the list. */ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) { if (driver->scan) return driver->scan(options); return NULL; } SR_PRIV void sr_hw_cleanup_all(void) { int i; struct sr_dev_driver **drivers; drivers = sr_driver_list(); for (i = 0; drivers[i]; i++) { if (drivers[i]->cleanup) drivers[i]->cleanup(); } } /** * Returns information about the given driver or device instance. * * @param driver The sr_dev_driver struct to query. * @param id The type of information, in the form of an SR_HWCAP_* option. * @param data Pointer where the value. will be stored. Must not be NULL. * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL. * * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG * may be returned by the driver indicating it doesn't know that id, * but this is not to be flagged as an error by the caller; merely * as an indication that it's not applicable. */ SR_API int sr_info_get(struct sr_dev_driver *driver, int id, const void **data, const struct sr_dev_inst *sdi) { int ret; if (driver == NULL || data == NULL) return SR_ERR; ret = driver->info_get(id, data, sdi); return ret; } SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, const char *vendor, const char *model, const char *version) { struct sr_dev_inst *sdi; if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { sr_err("hwdriver: %s: sdi malloc failed", __func__); return NULL; } sdi->index = index; sdi->status = status; sdi->inst_type = -1; sdi->vendor = vendor ? g_strdup(vendor) : NULL; sdi->model = model ? g_strdup(model) : NULL; sdi->version = version ? g_strdup(version) : NULL; sdi->probes = NULL; sdi->priv = NULL; return sdi; } SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index) { struct sr_dev_inst *sdi; GSList *l; for (l = dev_insts; l; l = l->next) { sdi = (struct sr_dev_inst *)(l->data); if (sdi->index == dev_index) return sdi; } sr_warn("could not find device index %d instance", dev_index); return NULL; } SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) { g_free(sdi->priv); g_free(sdi->vendor); g_free(sdi->model); g_free(sdi->version); g_free(sdi); } SR_PRIV struct sr_probe *sr_probe_new(int index, int type, gboolean enabled, const char *name) { struct sr_probe *probe; if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) { sr_err("hwdriver: probe malloc failed"); return NULL; } probe->index = index; probe->type = type; probe->enabled = enabled; if (name) probe->name = g_strdup(name); return probe; } #ifdef HAVE_LIBUSB_1_0 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, uint8_t address, struct libusb_device_handle *hdl) { struct sr_usb_dev_inst *udi; if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { sr_err("hwdriver: %s: udi malloc failed", __func__); return NULL; } udi->bus = bus; udi->address = address; udi->devhdl = hdl; return udi; } SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) { /* Avoid compiler warnings. */ (void)usb; /* Nothing to do for this device instance type. */ } #endif SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, int fd) { struct sr_serial_dev_inst *serial; if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) { sr_err("hwdriver: %s: serial malloc failed", __func__); return NULL; } serial->port = g_strdup(port); serial->fd = fd; return serial; } SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) { g_free(serial->port); } /** * Find out if a hardware driver has a specific capability. * * @param driver The hardware driver in which to search for the capability. * @param hwcap The capability to find in the list. * * @return TRUE if the specified capability exists in the specified driver, * FALSE otherwise. Also, if 'driver' is NULL or the respective driver * returns an invalid capability list, FALSE is returned. */ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) { const int *hwcaps; int i; if (!driver) { sr_err("hwdriver: %s: driver was NULL", __func__); return FALSE; } if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) return FALSE; for (i = 0; hwcaps[i]; i++) { if (hwcaps[i] == hwcap) return TRUE; } return FALSE; } /** * Get a hardware driver option. * * @param hwopt The option to get. * * @return A pointer to a struct with information about the parameter, or NULL * if the option was not found. */ SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt) { int i; for (i = 0; sr_drvopts[i].hwcap; i++) { if (sr_drvopts[i].hwcap == hwopt) return &sr_drvopts[i]; } return NULL; } /** * Get a hardware driver capability option. * * @param hwcap The capability to get. * * @return A pointer to a struct with information about the parameter, or NULL * if the capability was not found. */ SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) { int i; for (i = 0; sr_hwcap_options[i].hwcap; i++) { if (sr_hwcap_options[i].hwcap == hwcap) return &sr_hwcap_options[i]; } return NULL; } /* Unnecessary level of indirection follows. */ SR_PRIV int sr_source_remove(int fd) { return sr_session_source_remove(fd); } SR_PRIV int sr_source_add(int fd, int events, int timeout, sr_receive_data_callback_t cb, void *cb_data) { return sr_session_source_add(fd, events, timeout, cb, cb_data); }