]> sigrok.org Git - libsigrok.git/blame - src/hardware/mic-985xx/api.c
fx2lafw: Replace obsoleted strncmp() calls.
[libsigrok.git] / src / hardware / mic-985xx / api.c
CommitLineData
7ec5b549
UH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#include "protocol.h"
22
a0e0bb41 23static const uint32_t scanopts[] = {
0cd8e231
UH
24 SR_CONF_CONN,
25 SR_CONF_SERIALCOMM,
0cd8e231
UH
26};
27
e07edc83
UH
28static const uint32_t drvopts_temp[] = {
29 SR_CONF_THERMOMETER,
30};
31
32static const uint32_t drvopts_temp_hum[] = {
0cd8e231
UH
33 SR_CONF_THERMOMETER,
34 SR_CONF_HYGROMETER,
d6e1e6c4
UH
35};
36
37static const uint32_t devopts[] = {
38 SR_CONF_CONTINUOUS | SR_CONF_SET,
5827f61b
BV
39 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
40 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
0cd8e231 41};
7ec5b549 42
6f3e5335 43SR_PRIV struct sr_dev_driver mic_98581_driver_info;
0cd8e231
UH
44SR_PRIV struct sr_dev_driver mic_98583_driver_info;
45
46SR_PRIV const struct mic_dev_info mic_devs[] = {
47 {
6f3e5335
UH
48 "MIC", "98581", "38400/8n2", 32000, TRUE, FALSE, 6,
49 packet_valid_temp,
50 &mic_98581_driver_info, receive_data_MIC_98581,
51 },
52 {
53 "MIC", "98583", "38400/8n2", 32000, TRUE, TRUE, 10,
54 packet_valid_temp_hum,
0cd8e231
UH
55 &mic_98583_driver_info, receive_data_MIC_98583,
56 },
57};
58
3b412e3a 59static int dev_clear(int idx)
7ec5b549 60{
25e7adad 61 return std_dev_clear(mic_devs[idx].di, NULL);
7ec5b549
UH
62}
63
6078d2c9 64static int init(struct sr_context *sr_ctx, int idx)
7ec5b549 65{
f6beaac5 66 return std_init(sr_ctx, mic_devs[idx].di, LOG_PREFIX);
7ec5b549
UH
67}
68
6078d2c9 69static GSList *mic_scan(const char *conn, const char *serialcomm, int idx)
7ec5b549 70{
0cd8e231 71 struct sr_dev_inst *sdi;
7ec5b549 72 struct drv_context *drvc;
0cd8e231 73 struct dev_context *devc;
ba7dd8bb 74 struct sr_channel *ch;
0cd8e231 75 struct sr_serial_dev_inst *serial;
7ec5b549
UH
76 GSList *devices;
77
91219afc 78 serial = sr_serial_dev_inst_new(conn, serialcomm);
7ec5b549 79
51056d61 80 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
0cd8e231
UH
81 return NULL;
82
83 drvc = mic_devs[idx].di->priv;
7ec5b549 84 devices = NULL;
0cd8e231 85 serial_flush(serial);
7ec5b549 86
0cd8e231
UH
87 /* TODO: Query device type. */
88 // ret = mic_cmd_get_device_info(serial);
89
90 sr_info("Found device on port %s.", conn);
91
92 /* TODO: Fill in version from protocol response. */
aac29cc1 93 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
94 sdi->status = SR_ST_INACTIVE;
95 sdi->vendor = g_strdup(mic_devs[idx].vendor);
96 sdi->model = g_strdup(mic_devs[idx].device);
f57d8ffe 97 devc = g_malloc0(sizeof(struct dev_context));
886bd5e0
UH
98 sdi->inst_type = SR_INST_SERIAL;
99 sdi->conn = serial;
0cd8e231
UH
100 sdi->priv = devc;
101 sdi->driver = mic_devs[idx].di;
102
c368e6f3 103 ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "Temperature");
ba7dd8bb 104 sdi->channels = g_slist_append(sdi->channels, ch);
0cd8e231 105
6f3e5335 106 if (mic_devs[idx].has_humidity) {
c368e6f3 107 ch = sr_channel_new(1, SR_CHANNEL_ANALOG, TRUE, "Humidity");
ba7dd8bb 108 sdi->channels = g_slist_append(sdi->channels, ch);
6f3e5335 109 }
0cd8e231
UH
110
111 drvc->instances = g_slist_append(drvc->instances, sdi);
112 devices = g_slist_append(devices, sdi);
113
0cd8e231 114 serial_close(serial);
7ec5b549
UH
115
116 return devices;
117}
118
6078d2c9 119static GSList *scan(GSList *options, int idx)
0cd8e231
UH
120{
121 struct sr_config *src;
122 GSList *l, *devices;
123 const char *conn, *serialcomm;
124
125 conn = serialcomm = NULL;
126 for (l = options; l; l = l->next) {
127 src = l->data;
128 switch (src->key) {
129 case SR_CONF_CONN:
2c2be401 130 conn = g_variant_get_string(src->data, NULL);
0cd8e231
UH
131 break;
132 case SR_CONF_SERIALCOMM:
06c45a66 133 serialcomm = g_variant_get_string(src->data, NULL);
0cd8e231
UH
134 break;
135 }
136 }
137 if (!conn)
138 return NULL;
139
140 if (serialcomm) {
141 /* Use the provided comm specs. */
6078d2c9 142 devices = mic_scan(conn, serialcomm, idx);
0cd8e231
UH
143 } else {
144 /* Try the default. */
6078d2c9 145 devices = mic_scan(conn, mic_devs[idx].conn, idx);
0cd8e231
UH
146 }
147
148 return devices;
149}
150
6078d2c9 151static GSList *dev_list(int idx)
7ec5b549 152{
0e94d524 153 return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
7ec5b549
UH
154}
155
6078d2c9 156static int cleanup(int idx)
7ec5b549 157{
3b412e3a 158 return dev_clear(idx);
7ec5b549
UH
159}
160
584560f1 161static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 162 const struct sr_channel_group *cg)
7ec5b549 163{
0cd8e231 164 struct dev_context *devc;
7ec5b549 165
53b4680f 166 (void)cg;
8f996b89 167
0cd8e231 168 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 169 return SR_ERR_DEV_CLOSED;
7ec5b549 170
0cd8e231
UH
171 devc = sdi->priv;
172
584560f1 173 switch (key) {
0cd8e231 174 case SR_CONF_LIMIT_SAMPLES:
2c2be401 175 devc->limit_samples = g_variant_get_uint64(data);
0cd8e231
UH
176 sr_dbg("Setting sample limit to %" PRIu64 ".",
177 devc->limit_samples);
178 break;
179 case SR_CONF_LIMIT_MSEC:
2c2be401 180 devc->limit_msec = g_variant_get_uint64(data);
0cd8e231
UH
181 sr_dbg("Setting time limit to %" PRIu64 "ms.",
182 devc->limit_msec);
183 break;
7ec5b549 184 default:
bd6fbf62 185 return SR_ERR_NA;
7ec5b549
UH
186 }
187
0cd8e231 188 return SR_OK;
7ec5b549
UH
189}
190
584560f1 191static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
e07edc83 192 const struct sr_channel_group *cg, int idx)
7ec5b549 193{
53b4680f 194 (void)cg;
7ec5b549
UH
195
196 switch (key) {
0cd8e231 197 case SR_CONF_SCAN_OPTIONS:
584560f1 198 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 199 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0cd8e231
UH
200 break;
201 case SR_CONF_DEVICE_OPTIONS:
e07edc83
UH
202 if (!sdi && !mic_devs[idx].has_humidity) {
203 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
204 drvopts_temp, ARRAY_SIZE(drvopts_temp),
205 sizeof(uint32_t));
206 } else if (!sdi && mic_devs[idx].has_humidity) {
d6e1e6c4 207 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
e07edc83
UH
208 drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
209 sizeof(uint32_t));
210 } else {
d6e1e6c4 211 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 212 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
e07edc83 213 }
0cd8e231 214 break;
7ec5b549 215 default:
bd6fbf62 216 return SR_ERR_NA;
7ec5b549
UH
217 }
218
219 return SR_OK;
220}
221
6078d2c9 222static int dev_acquisition_start(const struct sr_dev_inst *sdi,
0cd8e231 223 void *cb_data, int idx)
7ec5b549 224{
0cd8e231 225 struct dev_context *devc;
886bd5e0 226 struct sr_serial_dev_inst *serial;
0cd8e231 227
e73ffd42
BV
228 if (sdi->status != SR_ST_ACTIVE)
229 return SR_ERR_DEV_CLOSED;
0cd8e231 230
e73ffd42 231 devc = sdi->priv;
0cd8e231 232 devc->cb_data = cb_data;
0cd8e231
UH
233 devc->num_samples = 0;
234 devc->starttime = g_get_monotonic_time();
235
236 /* Send header packet to the session bus. */
29a27196 237 std_session_send_df_header(cb_data, LOG_PREFIX);
0cd8e231
UH
238
239 /* Poll every 100ms, or whenever some data comes in. */
886bd5e0 240 serial = sdi->conn;
102f1239 241 serial_source_add(sdi->session, serial, G_IO_IN, 100,
0cd8e231 242 mic_devs[idx].receive_data, (void *)sdi);
7ec5b549
UH
243
244 return SR_OK;
245}
246
6078d2c9 247static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
7ec5b549 248{
d43b0908
BV
249 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
250 sdi->conn, LOG_PREFIX);
7ec5b549
UH
251}
252
0cd8e231
UH
253/* Driver-specific API function wrappers */
254#define HW_INIT(X) \
6078d2c9 255static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
0cd8e231 256#define HW_CLEANUP(X) \
6078d2c9 257static int cleanup_##X(void) { return cleanup(X); }
0cd8e231 258#define HW_SCAN(X) \
6078d2c9 259static GSList *scan_##X(GSList *options) { return scan(options, X); }
0cd8e231 260#define HW_DEV_LIST(X) \
6078d2c9 261static GSList *dev_list_##X(void) { return dev_list(X); }
3b412e3a
UH
262#define HW_DEV_CLEAR(X) \
263static int dev_clear_##X(void) { return dev_clear(X); }
e07edc83
UH
264#define HW_CONFIG_LIST(X) \
265static int config_list_##X(uint32_t key, GVariant **data, \
266const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { \
267return config_list(key, data, sdi, cg, X); }
0cd8e231 268#define HW_DEV_ACQUISITION_START(X) \
6078d2c9
UH
269static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
270void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
0cd8e231
UH
271
272/* Driver structs and API function wrappers */
273#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
274HW_INIT(ID_UPPER) \
275HW_CLEANUP(ID_UPPER) \
276HW_SCAN(ID_UPPER) \
277HW_DEV_LIST(ID_UPPER) \
3b412e3a 278HW_DEV_CLEAR(ID_UPPER) \
e07edc83 279HW_CONFIG_LIST(ID_UPPER) \
0cd8e231
UH
280HW_DEV_ACQUISITION_START(ID_UPPER) \
281SR_PRIV struct sr_dev_driver ID##_driver_info = { \
282 .name = NAME, \
283 .longname = LONGNAME, \
284 .api_version = 1, \
6078d2c9
UH
285 .init = init_##ID_UPPER, \
286 .cleanup = cleanup_##ID_UPPER, \
287 .scan = scan_##ID_UPPER, \
288 .dev_list = dev_list_##ID_UPPER, \
3b412e3a 289 .dev_clear = dev_clear_##ID_UPPER, \
0cd8e231
UH
290 .config_get = NULL, \
291 .config_set = config_set, \
e07edc83 292 .config_list = config_list_##ID_UPPER, \
854434de 293 .dev_open = std_serial_dev_open, \
bf2c987f 294 .dev_close = std_serial_dev_close, \
6078d2c9
UH
295 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
296 .dev_acquisition_stop = dev_acquisition_stop, \
0cd8e231 297 .priv = NULL, \
7ec5b549 298};
0cd8e231 299
6f3e5335 300DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231 301DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")