]> sigrok.org Git - libsigrok.git/blame - src/hardware/mic-985xx/api.c
Consistently use g_malloc0() for allocating devc.
[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
0cd8e231
UH
78 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
79 return NULL;
7ec5b549 80
51056d61 81 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
0cd8e231
UH
82 return NULL;
83
84 drvc = mic_devs[idx].di->priv;
7ec5b549 85 devices = NULL;
0cd8e231 86 serial_flush(serial);
7ec5b549 87
0cd8e231
UH
88 /* TODO: Query device type. */
89 // ret = mic_cmd_get_device_info(serial);
90
91 sr_info("Found device on port %s.", conn);
92
93 /* TODO: Fill in version from protocol response. */
aac29cc1 94 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
95 sdi->status = SR_ST_INACTIVE;
96 sdi->vendor = g_strdup(mic_devs[idx].vendor);
97 sdi->model = g_strdup(mic_devs[idx].device);
f57d8ffe 98 devc = g_malloc0(sizeof(struct dev_context));
886bd5e0
UH
99 sdi->inst_type = SR_INST_SERIAL;
100 sdi->conn = serial;
0cd8e231
UH
101 sdi->priv = devc;
102 sdi->driver = mic_devs[idx].di;
103
3f239f08 104 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "Temperature")))
0cd8e231 105 goto scan_cleanup;
ba7dd8bb 106 sdi->channels = g_slist_append(sdi->channels, ch);
0cd8e231 107
6f3e5335 108 if (mic_devs[idx].has_humidity) {
3f239f08 109 if (!(ch = sr_channel_new(1, SR_CHANNEL_ANALOG, TRUE, "Humidity")))
6f3e5335 110 goto scan_cleanup;
ba7dd8bb 111 sdi->channels = g_slist_append(sdi->channels, ch);
6f3e5335 112 }
0cd8e231
UH
113
114 drvc->instances = g_slist_append(drvc->instances, sdi);
115 devices = g_slist_append(devices, sdi);
116
117scan_cleanup:
118 serial_close(serial);
7ec5b549
UH
119
120 return devices;
121}
122
6078d2c9 123static GSList *scan(GSList *options, int idx)
0cd8e231
UH
124{
125 struct sr_config *src;
126 GSList *l, *devices;
127 const char *conn, *serialcomm;
128
129 conn = serialcomm = NULL;
130 for (l = options; l; l = l->next) {
131 src = l->data;
132 switch (src->key) {
133 case SR_CONF_CONN:
2c2be401 134 conn = g_variant_get_string(src->data, NULL);
0cd8e231
UH
135 break;
136 case SR_CONF_SERIALCOMM:
06c45a66 137 serialcomm = g_variant_get_string(src->data, NULL);
0cd8e231
UH
138 break;
139 }
140 }
141 if (!conn)
142 return NULL;
143
144 if (serialcomm) {
145 /* Use the provided comm specs. */
6078d2c9 146 devices = mic_scan(conn, serialcomm, idx);
0cd8e231
UH
147 } else {
148 /* Try the default. */
6078d2c9 149 devices = mic_scan(conn, mic_devs[idx].conn, idx);
0cd8e231
UH
150 }
151
152 return devices;
153}
154
6078d2c9 155static GSList *dev_list(int idx)
7ec5b549 156{
0e94d524 157 return ((struct drv_context *)(mic_devs[idx].di->priv))->instances;
7ec5b549
UH
158}
159
6078d2c9 160static int cleanup(int idx)
7ec5b549 161{
3b412e3a 162 return dev_clear(idx);
7ec5b549
UH
163}
164
584560f1 165static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 166 const struct sr_channel_group *cg)
7ec5b549 167{
0cd8e231 168 struct dev_context *devc;
7ec5b549 169
53b4680f 170 (void)cg;
8f996b89 171
0cd8e231 172 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 173 return SR_ERR_DEV_CLOSED;
7ec5b549 174
0cd8e231
UH
175 devc = sdi->priv;
176
584560f1 177 switch (key) {
0cd8e231 178 case SR_CONF_LIMIT_SAMPLES:
2c2be401 179 devc->limit_samples = g_variant_get_uint64(data);
0cd8e231
UH
180 sr_dbg("Setting sample limit to %" PRIu64 ".",
181 devc->limit_samples);
182 break;
183 case SR_CONF_LIMIT_MSEC:
2c2be401 184 devc->limit_msec = g_variant_get_uint64(data);
0cd8e231
UH
185 sr_dbg("Setting time limit to %" PRIu64 "ms.",
186 devc->limit_msec);
187 break;
7ec5b549 188 default:
bd6fbf62 189 return SR_ERR_NA;
7ec5b549
UH
190 }
191
0cd8e231 192 return SR_OK;
7ec5b549
UH
193}
194
584560f1 195static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
e07edc83 196 const struct sr_channel_group *cg, int idx)
7ec5b549 197{
53b4680f 198 (void)cg;
7ec5b549
UH
199
200 switch (key) {
0cd8e231 201 case SR_CONF_SCAN_OPTIONS:
584560f1 202 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 203 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0cd8e231
UH
204 break;
205 case SR_CONF_DEVICE_OPTIONS:
e07edc83
UH
206 if (!sdi && !mic_devs[idx].has_humidity) {
207 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
208 drvopts_temp, ARRAY_SIZE(drvopts_temp),
209 sizeof(uint32_t));
210 } else if (!sdi && mic_devs[idx].has_humidity) {
d6e1e6c4 211 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
e07edc83
UH
212 drvopts_temp_hum, ARRAY_SIZE(drvopts_temp_hum),
213 sizeof(uint32_t));
214 } else {
d6e1e6c4 215 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 216 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
e07edc83 217 }
0cd8e231 218 break;
7ec5b549 219 default:
bd6fbf62 220 return SR_ERR_NA;
7ec5b549
UH
221 }
222
223 return SR_OK;
224}
225
6078d2c9 226static int dev_acquisition_start(const struct sr_dev_inst *sdi,
0cd8e231 227 void *cb_data, int idx)
7ec5b549 228{
0cd8e231 229 struct dev_context *devc;
886bd5e0 230 struct sr_serial_dev_inst *serial;
0cd8e231 231
e73ffd42
BV
232 if (sdi->status != SR_ST_ACTIVE)
233 return SR_ERR_DEV_CLOSED;
0cd8e231 234
e73ffd42 235 devc = sdi->priv;
0cd8e231 236 devc->cb_data = cb_data;
0cd8e231
UH
237 devc->num_samples = 0;
238 devc->starttime = g_get_monotonic_time();
239
240 /* Send header packet to the session bus. */
29a27196 241 std_session_send_df_header(cb_data, LOG_PREFIX);
0cd8e231
UH
242
243 /* Poll every 100ms, or whenever some data comes in. */
886bd5e0 244 serial = sdi->conn;
102f1239 245 serial_source_add(sdi->session, serial, G_IO_IN, 100,
0cd8e231 246 mic_devs[idx].receive_data, (void *)sdi);
7ec5b549
UH
247
248 return SR_OK;
249}
250
6078d2c9 251static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
7ec5b549 252{
d43b0908
BV
253 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
254 sdi->conn, LOG_PREFIX);
7ec5b549
UH
255}
256
0cd8e231
UH
257/* Driver-specific API function wrappers */
258#define HW_INIT(X) \
6078d2c9 259static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
0cd8e231 260#define HW_CLEANUP(X) \
6078d2c9 261static int cleanup_##X(void) { return cleanup(X); }
0cd8e231 262#define HW_SCAN(X) \
6078d2c9 263static GSList *scan_##X(GSList *options) { return scan(options, X); }
0cd8e231 264#define HW_DEV_LIST(X) \
6078d2c9 265static GSList *dev_list_##X(void) { return dev_list(X); }
3b412e3a
UH
266#define HW_DEV_CLEAR(X) \
267static int dev_clear_##X(void) { return dev_clear(X); }
e07edc83
UH
268#define HW_CONFIG_LIST(X) \
269static int config_list_##X(uint32_t key, GVariant **data, \
270const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) { \
271return config_list(key, data, sdi, cg, X); }
0cd8e231 272#define HW_DEV_ACQUISITION_START(X) \
6078d2c9
UH
273static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
274void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
0cd8e231
UH
275
276/* Driver structs and API function wrappers */
277#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
278HW_INIT(ID_UPPER) \
279HW_CLEANUP(ID_UPPER) \
280HW_SCAN(ID_UPPER) \
281HW_DEV_LIST(ID_UPPER) \
3b412e3a 282HW_DEV_CLEAR(ID_UPPER) \
e07edc83 283HW_CONFIG_LIST(ID_UPPER) \
0cd8e231
UH
284HW_DEV_ACQUISITION_START(ID_UPPER) \
285SR_PRIV struct sr_dev_driver ID##_driver_info = { \
286 .name = NAME, \
287 .longname = LONGNAME, \
288 .api_version = 1, \
6078d2c9
UH
289 .init = init_##ID_UPPER, \
290 .cleanup = cleanup_##ID_UPPER, \
291 .scan = scan_##ID_UPPER, \
292 .dev_list = dev_list_##ID_UPPER, \
3b412e3a 293 .dev_clear = dev_clear_##ID_UPPER, \
0cd8e231
UH
294 .config_get = NULL, \
295 .config_set = config_set, \
e07edc83 296 .config_list = config_list_##ID_UPPER, \
854434de 297 .dev_open = std_serial_dev_open, \
bf2c987f 298 .dev_close = std_serial_dev_close, \
6078d2c9
UH
299 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
300 .dev_acquisition_stop = dev_acquisition_stop, \
0cd8e231 301 .priv = NULL, \
7ec5b549 302};
0cd8e231 303
6f3e5335 304DRV(mic_98581, MIC_98581, "mic-98581", "MIC 98581")
0cd8e231 305DRV(mic_98583, MIC_98583, "mic-98583", "MIC 98583")