1 // SPDX-License-Identifier: GPL-2.0+
3 * GPIO driver for virtio-based virtual GPIO controllers
5 * Copyright (C) 2021 metux IT consult
6 * Enrico Weigelt, metux IT consult <info@metux.net>
8 * Copyright (C) 2021 Linaro.
9 * Viresh Kumar <viresh.kumar@linaro.org>
12 #include <linux/completion.h>
13 #include <linux/err.h>
14 #include <linux/gpio/driver.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/mutex.h>
19 #include <linux/virtio_config.h>
20 #include <uapi/linux/virtio_gpio.h>
21 #include <uapi/linux/virtio_ids.h>
23 struct virtio_gpio_line {
24 struct mutex lock; /* Protects line operation */
25 struct completion completion;
26 struct virtio_gpio_request req ____cacheline_aligned;
27 struct virtio_gpio_response res ____cacheline_aligned;
32 struct virtio_device *vdev;
33 struct mutex lock; /* Protects virtqueue operation */
35 struct virtio_gpio_line *lines;
36 struct virtqueue *request_vq;
39 static int _virtio_gpio_req(struct virtio_gpio *vgpio, u16 type, u16 gpio,
40 u8 txvalue, u8 *rxvalue, void *response, u32 rxlen)
42 struct virtio_gpio_line *line = &vgpio->lines[gpio];
43 struct virtio_gpio_request *req = &line->req;
44 struct virtio_gpio_response *res = response;
45 struct scatterlist *sgs[2], req_sg, res_sg;
46 struct device *dev = &vgpio->vdev->dev;
50 * Prevent concurrent requests for the same line since we have
51 * pre-allocated request/response buffers for each GPIO line. Moreover
52 * Linux always accesses a GPIO line sequentially, so this locking shall
53 * always go through without any delays.
55 mutex_lock(&line->lock);
57 req->type = cpu_to_le16(type);
58 req->gpio = cpu_to_le16(gpio);
59 req->value = cpu_to_le32(txvalue);
61 sg_init_one(&req_sg, req, sizeof(*req));
62 sg_init_one(&res_sg, res, rxlen);
67 reinit_completion(&line->completion);
70 * Virtqueue callers need to ensure they don't call its APIs with other
71 * virtqueue operations at the same time.
73 mutex_lock(&vgpio->lock);
74 ret = virtqueue_add_sgs(vgpio->request_vq, sgs, 1, 1, line, GFP_KERNEL);
76 dev_err(dev, "failed to add request to vq\n");
77 mutex_unlock(&vgpio->lock);
81 virtqueue_kick(vgpio->request_vq);
82 mutex_unlock(&vgpio->lock);
84 wait_for_completion(&line->completion);
86 if (unlikely(res->status != VIRTIO_GPIO_STATUS_OK)) {
87 dev_err(dev, "GPIO request failed: %d\n", gpio);
92 if (unlikely(line->rxlen != rxlen)) {
93 dev_err(dev, "GPIO operation returned incorrect len (%u : %u)\n",
100 *rxvalue = res->value;
103 mutex_unlock(&line->lock);
107 static int virtio_gpio_req(struct virtio_gpio *vgpio, u16 type, u16 gpio,
108 u8 txvalue, u8 *rxvalue)
110 struct virtio_gpio_line *line = &vgpio->lines[gpio];
111 struct virtio_gpio_response *res = &line->res;
113 return _virtio_gpio_req(vgpio, type, gpio, txvalue, rxvalue, res,
117 static void virtio_gpio_free(struct gpio_chip *gc, unsigned int gpio)
119 struct virtio_gpio *vgpio = gpiochip_get_data(gc);
121 virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_DIRECTION, gpio,
122 VIRTIO_GPIO_DIRECTION_NONE, NULL);
125 static int virtio_gpio_get_direction(struct gpio_chip *gc, unsigned int gpio)
127 struct virtio_gpio *vgpio = gpiochip_get_data(gc);
131 ret = virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_GET_DIRECTION, gpio, 0,
137 case VIRTIO_GPIO_DIRECTION_IN:
138 return GPIO_LINE_DIRECTION_IN;
139 case VIRTIO_GPIO_DIRECTION_OUT:
140 return GPIO_LINE_DIRECTION_OUT;
146 static int virtio_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)
148 struct virtio_gpio *vgpio = gpiochip_get_data(gc);
150 return virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_DIRECTION, gpio,
151 VIRTIO_GPIO_DIRECTION_IN, NULL);
154 static int virtio_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,
157 struct virtio_gpio *vgpio = gpiochip_get_data(gc);
160 ret = virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_VALUE, gpio, value, NULL);
164 return virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_DIRECTION, gpio,
165 VIRTIO_GPIO_DIRECTION_OUT, NULL);
168 static int virtio_gpio_get(struct gpio_chip *gc, unsigned int gpio)
170 struct virtio_gpio *vgpio = gpiochip_get_data(gc);
174 ret = virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_GET_VALUE, gpio, 0, &value);
175 return ret ? ret : value;
178 static void virtio_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)
180 struct virtio_gpio *vgpio = gpiochip_get_data(gc);
182 virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_VALUE, gpio, value, NULL);
185 static void virtio_gpio_request_vq(struct virtqueue *vq)
187 struct virtio_gpio_line *line;
191 line = virtqueue_get_buf(vq, &len);
196 complete(&line->completion);
200 static void virtio_gpio_free_vqs(struct virtio_device *vdev)
202 vdev->config->reset(vdev);
203 vdev->config->del_vqs(vdev);
206 static int virtio_gpio_alloc_vqs(struct virtio_gpio *vgpio,
207 struct virtio_device *vdev)
209 const char * const names[] = { "requestq" };
210 vq_callback_t *cbs[] = {
211 virtio_gpio_request_vq,
213 struct virtqueue *vqs[1] = { NULL };
216 ret = virtio_find_vqs(vdev, 1, vqs, cbs, names, NULL);
218 dev_err(&vdev->dev, "failed to find vqs: %d\n", ret);
223 dev_err(&vdev->dev, "failed to find requestq vq\n");
226 vgpio->request_vq = vqs[0];
231 static const char **virtio_gpio_get_names(struct virtio_gpio *vgpio,
232 u32 gpio_names_size, u16 ngpio)
234 struct virtio_gpio_response_get_names *res;
235 struct device *dev = &vgpio->vdev->dev;
236 u8 *gpio_names, *str;
240 if (!gpio_names_size)
243 len = sizeof(*res) + gpio_names_size;
244 res = devm_kzalloc(dev, len, GFP_KERNEL);
247 gpio_names = res->value;
249 ret = _virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_GET_NAMES, 0, 0, NULL,
252 dev_err(dev, "Failed to get GPIO names: %d\n", ret);
256 names = devm_kcalloc(dev, ngpio, sizeof(*names), GFP_KERNEL);
260 /* NULL terminate the string instead of checking it */
261 gpio_names[gpio_names_size - 1] = '\0';
263 for (i = 0, str = gpio_names; i < ngpio; i++) {
265 str += strlen(str) + 1; /* zero-length strings are allowed */
267 if (str > gpio_names + gpio_names_size) {
268 dev_err(dev, "gpio_names block is too short (%d)\n", i);
276 static int virtio_gpio_probe(struct virtio_device *vdev)
278 struct virtio_gpio_config config;
279 struct device *dev = &vdev->dev;
280 struct virtio_gpio *vgpio;
285 vgpio = devm_kzalloc(dev, sizeof(*vgpio), GFP_KERNEL);
289 /* Read configuration */
290 virtio_cread_bytes(vdev, 0, &config, sizeof(config));
291 gpio_names_size = le32_to_cpu(config.gpio_names_size);
292 ngpio = le16_to_cpu(config.ngpio);
294 dev_err(dev, "Number of GPIOs can't be zero\n");
298 vgpio->lines = devm_kcalloc(dev, ngpio, sizeof(*vgpio->lines), GFP_KERNEL);
302 for (i = 0; i < ngpio; i++) {
303 mutex_init(&vgpio->lines[i].lock);
304 init_completion(&vgpio->lines[i].completion);
307 mutex_init(&vgpio->lock);
311 vgpio->gc.free = virtio_gpio_free;
312 vgpio->gc.get_direction = virtio_gpio_get_direction;
313 vgpio->gc.direction_input = virtio_gpio_direction_input;
314 vgpio->gc.direction_output = virtio_gpio_direction_output;
315 vgpio->gc.get = virtio_gpio_get;
316 vgpio->gc.set = virtio_gpio_set;
317 vgpio->gc.ngpio = ngpio;
318 vgpio->gc.base = -1; /* Allocate base dynamically */
319 vgpio->gc.label = dev_name(dev);
320 vgpio->gc.parent = dev;
321 vgpio->gc.owner = THIS_MODULE;
322 vgpio->gc.can_sleep = true;
324 ret = virtio_gpio_alloc_vqs(vgpio, vdev);
328 /* Mark the device ready to perform operations from within probe() */
329 virtio_device_ready(vdev);
331 vgpio->gc.names = virtio_gpio_get_names(vgpio, gpio_names_size, ngpio);
333 ret = gpiochip_add_data(&vgpio->gc, vgpio);
335 virtio_gpio_free_vqs(vdev);
336 dev_err(dev, "Failed to add virtio-gpio controller\n");
342 static void virtio_gpio_remove(struct virtio_device *vdev)
344 struct virtio_gpio *vgpio = vdev->priv;
346 gpiochip_remove(&vgpio->gc);
347 virtio_gpio_free_vqs(vdev);
350 static const struct virtio_device_id id_table[] = {
351 { VIRTIO_ID_GPIO, VIRTIO_DEV_ANY_ID },
354 MODULE_DEVICE_TABLE(virtio, id_table);
356 static struct virtio_driver virtio_gpio_driver = {
357 .id_table = id_table,
358 .probe = virtio_gpio_probe,
359 .remove = virtio_gpio_remove,
361 .name = KBUILD_MODNAME,
362 .owner = THIS_MODULE,
365 module_virtio_driver(virtio_gpio_driver);
367 MODULE_AUTHOR("Enrico Weigelt, metux IT consult <info@metux.net>");
368 MODULE_AUTHOR("Viresh Kumar <viresh.kumar@linaro.org>");
369 MODULE_DESCRIPTION("VirtIO GPIO driver");
370 MODULE_LICENSE("GPL");