new-driver: keep driver_info local to the api.c source file
[sigrok-util.git] / source / drv-api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) {year} {author} <{email}>
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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include "protocol.h"
22
23 static struct sr_dev_driver {lib}_driver_info;
24
25 static GSList *scan(struct sr_dev_driver *di, GSList *options)
26 {{
27         struct drv_context *drvc;
28         GSList *devices;
29
30         (void)options;
31
32         devices = NULL;
33         drvc = di->context;
34         drvc->instances = NULL;
35
36         /* TODO: scan for devices, either based on a SR_CONF_CONN option
37          * or on a USB scan. */
38
39         return devices;
40 }}
41
42 static int dev_open(struct sr_dev_inst *sdi)
43 {{
44         (void)sdi;
45
46         /* TODO: get handle from sdi->conn and open it. */
47
48         return SR_OK;
49 }}
50
51 static int dev_close(struct sr_dev_inst *sdi)
52 {{
53         (void)sdi;
54
55         /* TODO: get handle from sdi->conn and close it. */
56
57         return SR_OK;
58 }}
59
60 static int config_get(uint32_t key, GVariant **data,
61         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
62 {{
63         int ret;
64
65         (void)sdi;
66         (void)data;
67         (void)cg;
68
69         ret = SR_OK;
70         switch (key) {{
71         /* TODO */
72         default:
73                 return SR_ERR_NA;
74         }}
75
76         return ret;
77 }}
78
79 static int config_set(uint32_t key, GVariant *data,
80         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
81 {{
82         int ret;
83
84         (void)sdi;
85         (void)data;
86         (void)cg;
87
88         ret = SR_OK;
89         switch (key) {{
90         /* TODO */
91         default:
92                 ret = SR_ERR_NA;
93         }}
94
95         return ret;
96 }}
97
98 static int config_list(uint32_t key, GVariant **data,
99         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
100 {{
101         int ret;
102
103         (void)sdi;
104         (void)data;
105         (void)cg;
106
107         ret = SR_OK;
108         switch (key) {{
109         /* TODO */
110         default:
111                 return SR_ERR_NA;
112         }}
113
114         return ret;
115 }}
116
117 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
118 {{
119         /* TODO: configure hardware, reset acquisition state, set up
120          * callbacks and send header packet. */
121
122         (void)sdi;
123
124         return SR_OK;
125 }}
126
127 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
128 {{
129         /* TODO: stop acquisition. */
130
131         (void)sdi;
132
133         return SR_OK;
134 }}
135
136 static struct sr_dev_driver {lib}_driver_info = {{
137         .name = "{short}",
138         .longname = "{name}",
139         .api_version = 1,
140         .init = std_init,
141         .cleanup = std_cleanup,
142         .scan = scan,
143         .dev_list = std_dev_list,
144         .dev_clear = std_dev_clear,
145         .config_get = config_get,
146         .config_set = config_set,
147         .config_list = config_list,
148         .dev_open = dev_open,
149         .dev_close = dev_close,
150         .dev_acquisition_start = dev_acquisition_start,
151         .dev_acquisition_stop = dev_acquisition_stop,
152         .context = NULL,
153 }};
154 SR_REGISTER_DEV_DRIVER({lib}_driver_info);