]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/kern-scale/api.c
scpi-pps: Add a missing "break" in config_get().
[libsigrok.git] / src / hardware / kern-scale / api.c
index 2d68fcf652491de73b98fa50737d84390585de67..e369a44cf5e585722dbec8acf544b8a90b8119e8 100644 (file)
  * 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, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
+#include <glib.h>
+#include <libsigrok/libsigrok.h>
+#include "libsigrok-internal.h"
 #include "protocol.h"
 
-SR_PRIV struct sr_dev_driver kern_scale_driver_info;
+static const uint32_t scanopts[] = {
+       SR_CONF_CONN,
+       SR_CONF_SERIALCOMM,
+};
 
-static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
+static const uint32_t drvopts[] = {
+       SR_CONF_SCALE,
+};
+
+static const uint32_t devopts[] = {
+       SR_CONF_CONTINUOUS,
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
+       SR_CONF_LIMIT_MSEC | SR_CONF_SET,
+};
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
-       struct drv_context *drvc;
-       GSList *devices;
+       struct scale_info *scale;
+       struct sr_config *src;
+       GSList *l, *devices;
+       const char *conn, *serialcomm;
+       struct sr_dev_inst *sdi;
+       struct dev_context *devc;
+       struct sr_serial_dev_inst *serial;
+       int ret;
+       size_t len;
+       uint8_t buf[128];
+
+       scale = (struct scale_info *)di;
+
+       conn = serialcomm = NULL;
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       conn = g_variant_get_string(src->data, NULL);
+                       break;
+               case SR_CONF_SERIALCOMM:
+                       serialcomm = g_variant_get_string(src->data, NULL);
+                       break;
+               }
+       }
+       if (!conn)
+               return NULL;
 
-       (void)options;
+       if (!serialcomm)
+               serialcomm = scale->conn;
 
-       devices = NULL;
-       drvc = di->context;
-       drvc->instances = NULL;
+       serial = sr_serial_dev_inst_new(conn, serialcomm);
 
-       return devices;
-}
+       if (serial_open(serial, SERIAL_RDWR) != SR_OK)
+               return NULL;
 
-static GSList *dev_list(const struct sr_dev_driver *di)
-{
-       return ((struct drv_context *)(di->context))->instances;
-}
+       sr_info("Probing serial port %s.", conn);
 
-static int dev_clear(const struct sr_dev_driver *di)
-{
-       return std_dev_clear(di, NULL);
-}
-
-static int dev_open(struct sr_dev_inst *sdi)
-{
-       (void)sdi;
+       devices = NULL;
+       serial_flush(serial);
 
-       sdi->status = SR_ST_ACTIVE;
+       sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
+       if (serial_write_blocking(serial, "O1\r\n", 4, 0) < 0)
+               goto scan_cleanup;
+       /* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
 
-       return SR_OK;
-}
+       /* Let's get a bit of data and see if we can find a packet. */
+       len = sizeof(buf);
+       ret = serial_stream_detect(serial, buf, &len, scale->packet_size,
+                                  scale->packet_valid, 3000, scale->baudrate);
+       if (ret != SR_OK)
+               goto scan_cleanup;
 
-static int dev_close(struct sr_dev_inst *sdi)
-{
-       (void)sdi;
+       sr_info("Found device on port %s.", conn);
 
+       sdi = g_malloc0(sizeof(struct sr_dev_inst));
        sdi->status = SR_ST_INACTIVE;
-
-       return SR_OK;
-}
-
-static int cleanup(const struct sr_dev_driver *di)
-{
-       dev_clear(di);
-
-       return SR_OK;
+       sdi->vendor = g_strdup(scale->vendor);
+       sdi->model = g_strdup(scale->device);
+       devc = g_malloc0(sizeof(struct dev_context));
+       sr_sw_limits_init(&devc->limits);
+       sdi->inst_type = SR_INST_SERIAL;
+       sdi->conn = serial;
+       sdi->priv = devc;
+       sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Mass");
+       devices = g_slist_append(devices, sdi);
+
+scan_cleanup:
+       serial_close(serial);
+
+       return std_scan_complete(di, devices);
 }
 
-static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
+       struct dev_context *devc;
 
-       (void)sdi;
-       (void)data;
        (void)cg;
 
-       ret = SR_OK;
-       switch (key) {
-       default:
-               return SR_ERR_NA;
-       }
+       devc = sdi->priv;
 
-       return ret;
+       return sr_sw_limits_config_set(&devc->limits, key, data);
 }
 
-static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       int ret;
-
-       (void)data;
-       (void)cg;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       ret = SR_OK;
-       switch (key) {
-       default:
-               ret = SR_ERR_NA;
-       }
-
-       return ret;
+       return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 }
 
-static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
-       int ret;
+       struct dev_context *devc;
+       struct sr_serial_dev_inst *serial;
 
-       (void)sdi;
-       (void)data;
-       (void)cg;
+       devc = sdi->priv;
+       serial = sdi->conn;
 
-       ret = SR_OK;
-       switch (key) {
-       default:
-               return SR_ERR_NA;
-       }
-
-       return ret;
-}
+       sr_spew("Set O1 mode (continuous values, stable and unstable ones).");
+       if (serial_write_blocking(serial, "O1\r\n", 4, 0) < 0)
+               return SR_ERR;
+       /* Device replies with "A00\r\n" (OK) or "E01\r\n" (Error). Ignore. */
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
-{
-       (void)sdi;
-       (void)cb_data;
+       sr_sw_limits_acquisition_start(&devc->limits);
+       std_session_send_df_header(sdi);
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+       serial_source_add(sdi->session, serial, G_IO_IN, 50,
+                     kern_scale_receive_data, (void *)sdi);
 
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
-{
-       (void)cb_data;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+#define SCALE(ID, CHIPSET, VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
+                       VALID, PARSE) \
+       &((struct scale_info) { \
+               { \
+                       .name = ID, \
+                       .longname = VENDOR " " MODEL, \
+                       .api_version = 1, \
+                       .init = std_init, \
+                       .cleanup = std_cleanup, \
+                       .scan = scan, \
+                       .dev_list = std_dev_list, \
+                       .dev_clear = std_dev_clear, \
+                       .config_get = NULL, \
+                       .config_set = config_set, \
+                       .config_list = config_list, \
+                       .dev_open = std_serial_dev_open, \
+                       .dev_close = std_serial_dev_close, \
+                       .dev_acquisition_start = dev_acquisition_start, \
+                       .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
+                       .context = NULL, \
+               }, \
+               VENDOR, MODEL, CONN, BAUDRATE, PACKETSIZE, \
+               VALID, PARSE, sizeof(struct CHIPSET##_info) \
+       }).di
 
-       return SR_OK;
-}
+/*
+ * Some scales have (user-configurable) 14-byte or 15-byte packets.
+ * We transparently support both variants by specifying the larger value
+ * below and due to the way the stream parser works.
+ *
+ * The scales have a standard baudrate (model dependent) as listed below,
+ * but serial parameters are user-configurable. We support that by letting
+ * the user override them via "serialcomm".
+ */
 
-SR_PRIV struct sr_dev_driver kern_scale_driver_info = {
-       .name = "kern-scale",
-       .longname = "KERN Scale",
-       .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
-       .scan = scan,
-       .dev_list = dev_list,
-       .dev_clear = dev_clear,
-       .config_get = config_get,
-       .config_set = config_set,
-       .config_list = config_list,
-       .dev_open = dev_open,
-       .dev_close = dev_close,
-       .dev_acquisition_start = dev_acquisition_start,
-       .dev_acquisition_stop = dev_acquisition_stop,
-       .context = NULL,
-};
+SR_REGISTER_DEV_DRIVER_LIST(kern_scale_drivers,
+       SCALE(
+               "kern-ew-6200-2nm", kern,
+               "KERN", "EW 6200-2NM", "1200/8n2", 1200,
+               15 /* (or 14) */, sr_kern_packet_valid, sr_kern_parse
+       )
+);