1 // SPDX-License-Identifier: GPL-2.0+
3  * GPIO driver for virtio-based virtual GPIO controllers
14 #include <linux/gpio/driver.h>
58 static int _virtio_gpio_req(struct virtio_gpio *vgpio, u16 type, u16 gpio,  in _virtio_gpio_req()  argument
61 	struct virtio_gpio_line *line = &vgpio->lines[gpio];  in _virtio_gpio_req()
62 	struct virtio_gpio_request *req = &line->req;  in _virtio_gpio_req()
65 	struct device *dev = &vgpio->vdev->dev;  in _virtio_gpio_req()
70 	 * pre-allocated request/response buffers for each GPIO line. Moreover  in _virtio_gpio_req()
71 	 * Linux always accesses a GPIO line sequentially, so this locking shall  in _virtio_gpio_req()
72 	 * always go through without any delays.  in _virtio_gpio_req()
74 	mutex_lock(&line->lock);  in _virtio_gpio_req()
76 	req->type = cpu_to_le16(type);  in _virtio_gpio_req()
77 	req->gpio = cpu_to_le16(gpio);  in _virtio_gpio_req()
78 	req->value = cpu_to_le32(txvalue);  in _virtio_gpio_req()
85 	line->rxlen = 0;  in _virtio_gpio_req()
86 	reinit_completion(&line->completion);  in _virtio_gpio_req()
92 	mutex_lock(&vgpio->lock);  in _virtio_gpio_req()
93 	ret = virtqueue_add_sgs(vgpio->request_vq, sgs, 1, 1, line, GFP_KERNEL);  in _virtio_gpio_req()
96 		mutex_unlock(&vgpio->lock);  in _virtio_gpio_req()
100 	virtqueue_kick(vgpio->request_vq);  in _virtio_gpio_req()
101 	mutex_unlock(&vgpio->lock);  in _virtio_gpio_req()
103 	wait_for_completion(&line->completion);  in _virtio_gpio_req()
105 	if (unlikely(res->status != VIRTIO_GPIO_STATUS_OK)) {  in _virtio_gpio_req()
106 		dev_err(dev, "GPIO request failed: %d\n", gpio);  in _virtio_gpio_req()
107 		ret = -EINVAL;  in _virtio_gpio_req()
111 	if (unlikely(line->rxlen != rxlen)) {  in _virtio_gpio_req()
112 		dev_err(dev, "GPIO operation returned incorrect len (%u : %u)\n",  in _virtio_gpio_req()
113 			rxlen, line->rxlen);  in _virtio_gpio_req()
114 		ret = -EINVAL;  in _virtio_gpio_req()
119 		*rxvalue = res->value;  in _virtio_gpio_req()
122 	mutex_unlock(&line->lock);  in _virtio_gpio_req()
126 static int virtio_gpio_req(struct virtio_gpio *vgpio, u16 type, u16 gpio,  in virtio_gpio_req()  argument
129 	struct virtio_gpio_line *line = &vgpio->lines[gpio];  in virtio_gpio_req()
130 	struct virtio_gpio_response *res = &line->res;  in virtio_gpio_req()
132 	return _virtio_gpio_req(vgpio, type, gpio, txvalue, rxvalue, res,  in virtio_gpio_req()
136 static void virtio_gpio_free(struct gpio_chip *gc, unsigned int gpio)  in virtio_gpio_free()  argument
140 	virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_DIRECTION, gpio,  in virtio_gpio_free()
144 static int virtio_gpio_get_direction(struct gpio_chip *gc, unsigned int gpio)  in virtio_gpio_get_direction()  argument
150 	ret = virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_GET_DIRECTION, gpio, 0,  in virtio_gpio_get_direction()
161 		return -EINVAL;  in virtio_gpio_get_direction()
165 static int virtio_gpio_direction_input(struct gpio_chip *gc, unsigned int gpio)  in virtio_gpio_direction_input()  argument
169 	return virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_DIRECTION, gpio,  in virtio_gpio_direction_input()
173 static int virtio_gpio_direction_output(struct gpio_chip *gc, unsigned int gpio,  in virtio_gpio_direction_output()  argument
179 	ret = virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_VALUE, gpio, value, NULL);  in virtio_gpio_direction_output()
183 	return virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_DIRECTION, gpio,  in virtio_gpio_direction_output()
187 static int virtio_gpio_get(struct gpio_chip *gc, unsigned int gpio)  in virtio_gpio_get()  argument
193 	ret = virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_GET_VALUE, gpio, 0, &value);  in virtio_gpio_get()
197 static int virtio_gpio_set(struct gpio_chip *gc, unsigned int gpio, int value)  in virtio_gpio_set()  argument
201 	return virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_SET_VALUE, gpio, value,  in virtio_gpio_set()
206 static void virtio_gpio_irq_prepare(struct virtio_gpio *vgpio, u16 gpio)  in virtio_gpio_irq_prepare()  argument
208 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[gpio];  in virtio_gpio_irq_prepare()
209 	struct virtio_gpio_irq_request *ireq = &irq_line->ireq;  in virtio_gpio_irq_prepare()
210 	struct virtio_gpio_irq_response *ires = &irq_line->ires;  in virtio_gpio_irq_prepare()
214 	if (WARN_ON(irq_line->queued || irq_line->masked || irq_line->disabled))  in virtio_gpio_irq_prepare()
217 	ireq->gpio = cpu_to_le16(gpio);  in virtio_gpio_irq_prepare()
223 	ret = virtqueue_add_sgs(vgpio->event_vq, sgs, 1, 1, irq_line, GFP_ATOMIC);  in virtio_gpio_irq_prepare()
225 		dev_err(&vgpio->vdev->dev, "failed to add request to eventq\n");  in virtio_gpio_irq_prepare()
229 	irq_line->queued = true;  in virtio_gpio_irq_prepare()
230 	virtqueue_kick(vgpio->event_vq);  in virtio_gpio_irq_prepare()
237 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[d->hwirq];  in virtio_gpio_irq_enable()
239 	raw_spin_lock(&vgpio->eventq_lock);  in virtio_gpio_irq_enable()
240 	irq_line->disabled = false;  in virtio_gpio_irq_enable()
241 	irq_line->masked = false;  in virtio_gpio_irq_enable()
242 	irq_line->queue_pending = true;  in virtio_gpio_irq_enable()
243 	raw_spin_unlock(&vgpio->eventq_lock);  in virtio_gpio_irq_enable()
245 	irq_line->update_pending = true;  in virtio_gpio_irq_enable()
252 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[d->hwirq];  in virtio_gpio_irq_disable()
254 	raw_spin_lock(&vgpio->eventq_lock);  in virtio_gpio_irq_disable()
255 	irq_line->disabled = true;  in virtio_gpio_irq_disable()
256 	irq_line->masked = true;  in virtio_gpio_irq_disable()
257 	irq_line->queue_pending = false;  in virtio_gpio_irq_disable()
258 	raw_spin_unlock(&vgpio->eventq_lock);  in virtio_gpio_irq_disable()
260 	irq_line->update_pending = true;  in virtio_gpio_irq_disable()
267 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[d->hwirq];  in virtio_gpio_irq_mask()
269 	raw_spin_lock(&vgpio->eventq_lock);  in virtio_gpio_irq_mask()
270 	irq_line->masked = true;  in virtio_gpio_irq_mask()
271 	raw_spin_unlock(&vgpio->eventq_lock);  in virtio_gpio_irq_mask()
278 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[d->hwirq];  in virtio_gpio_irq_unmask()
280 	raw_spin_lock(&vgpio->eventq_lock);  in virtio_gpio_irq_unmask()
281 	irq_line->masked = false;  in virtio_gpio_irq_unmask()
284 	virtio_gpio_irq_prepare(vgpio, d->hwirq);  in virtio_gpio_irq_unmask()
285 	raw_spin_unlock(&vgpio->eventq_lock);  in virtio_gpio_irq_unmask()
292 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[d->hwirq];  in virtio_gpio_irq_set_type()
311 		dev_err(&vgpio->vdev->dev, "unsupported irq type: %u\n", type);  in virtio_gpio_irq_set_type()
312 		return -EINVAL;  in virtio_gpio_irq_set_type()
315 	irq_line->type = type;  in virtio_gpio_irq_set_type()
316 	irq_line->update_pending = true;  in virtio_gpio_irq_set_type()
326 	mutex_lock(&vgpio->irq_lock);  in virtio_gpio_irq_bus_lock()
333 	struct vgpio_irq_line *irq_line = &vgpio->irq_lines[d->hwirq];  in virtio_gpio_irq_bus_sync_unlock()
334 	u8 type = irq_line->disabled ? VIRTIO_GPIO_IRQ_TYPE_NONE : irq_line->type;  in virtio_gpio_irq_bus_sync_unlock()
337 	if (irq_line->update_pending) {  in virtio_gpio_irq_bus_sync_unlock()
338 		irq_line->update_pending = false;  in virtio_gpio_irq_bus_sync_unlock()
339 		virtio_gpio_req(vgpio, VIRTIO_GPIO_MSG_IRQ_TYPE, d->hwirq, type,  in virtio_gpio_irq_bus_sync_unlock()
343 		raw_spin_lock_irqsave(&vgpio->eventq_lock, flags);  in virtio_gpio_irq_bus_sync_unlock()
344 		if (irq_line->queue_pending) {  in virtio_gpio_irq_bus_sync_unlock()
345 			irq_line->queue_pending = false;  in virtio_gpio_irq_bus_sync_unlock()
346 			virtio_gpio_irq_prepare(vgpio, d->hwirq);  in virtio_gpio_irq_bus_sync_unlock()
348 		raw_spin_unlock_irqrestore(&vgpio->eventq_lock, flags);  in virtio_gpio_irq_bus_sync_unlock()
351 	mutex_unlock(&vgpio->irq_lock);  in virtio_gpio_irq_bus_sync_unlock()
354 static bool ignore_irq(struct virtio_gpio *vgpio, int gpio,  in ignore_irq()  argument
359 	raw_spin_lock(&vgpio->eventq_lock);  in ignore_irq()
360 	irq_line->queued = false;  in ignore_irq()
363 	if (irq_line->masked || irq_line->disabled) {  in ignore_irq()
372 	if (irq_line->ires.status == VIRTIO_GPIO_IRQ_STATUS_INVALID) {  in ignore_irq()
373 		virtio_gpio_irq_prepare(vgpio, gpio);  in ignore_irq()
378 	if (WARN_ON(irq_line->ires.status != VIRTIO_GPIO_IRQ_STATUS_VALID))  in ignore_irq()
382 	raw_spin_unlock(&vgpio->eventq_lock);  in ignore_irq()
389 	struct virtio_gpio *vgpio = vq->vdev->priv;  in virtio_gpio_event_vq()
390 	struct device *dev = &vgpio->vdev->dev;  in virtio_gpio_event_vq()
392 	int gpio, ret;  in virtio_gpio_event_vq()  local
396 		irq_line = virtqueue_get_buf(vgpio->event_vq, &len);  in virtio_gpio_event_vq()
400 		if (len != sizeof(irq_line->ires)) {  in virtio_gpio_event_vq()
402 				len, (unsigned int)sizeof(irq_line->ires));  in virtio_gpio_event_vq()
407 		 * Find GPIO line number from the offset of irq_line within the  in virtio_gpio_event_vq()
408 		 * irq_lines block. We can also get GPIO number from  in virtio_gpio_event_vq()
409 		 * irq-request, but better not to rely on a buffer returned by  in virtio_gpio_event_vq()
412 		gpio = irq_line - vgpio->irq_lines;  in virtio_gpio_event_vq()
413 		WARN_ON(gpio >= vgpio->gc.ngpio);  in virtio_gpio_event_vq()
415 		if (unlikely(ignore_irq(vgpio, gpio, irq_line)))  in virtio_gpio_event_vq()
418 		ret = generic_handle_domain_irq(vgpio->gc.irq.domain, gpio);  in virtio_gpio_event_vq()
434 		line->rxlen = len;  in virtio_gpio_request_vq()
435 		complete(&line->completion);  in virtio_gpio_request_vq()
442 	vdev->config->del_vqs(vdev);  in virtio_gpio_free_vqs()
455 	ret = virtio_find_vqs(vdev, vgpio->irq_lines ? 2 : 1, vqs,  in virtio_gpio_alloc_vqs()
458 		dev_err(&vdev->dev, "failed to find vqs: %d\n", ret);  in virtio_gpio_alloc_vqs()
463 		dev_err(&vdev->dev, "failed to find requestq vq\n");  in virtio_gpio_alloc_vqs()
466 	vgpio->request_vq = vqs[0];  in virtio_gpio_alloc_vqs()
468 	if (vgpio->irq_lines && !vqs[1]) {  in virtio_gpio_alloc_vqs()
469 		dev_err(&vdev->dev, "failed to find eventq vq\n");  in virtio_gpio_alloc_vqs()
472 	vgpio->event_vq = vqs[1];  in virtio_gpio_alloc_vqs()
480 	return -ENODEV;  in virtio_gpio_alloc_vqs()
487 	struct device *dev = &vgpio->vdev->dev;  in virtio_gpio_get_names()
499 	gpio_names = res->value;  in virtio_gpio_get_names()
504 		dev_err(dev, "Failed to get GPIO names: %d\n", ret);  in virtio_gpio_get_names()
513 	gpio_names[gpio_names_size - 1] = '\0';  in virtio_gpio_get_names()
517 		str += strlen(str) + 1; /* zero-length strings are allowed */  in virtio_gpio_get_names()
530 	struct device *dev = &vdev->dev;  in virtio_gpio_probe()
539 		return -ENOMEM;  in virtio_gpio_probe()
549 		return -EINVAL;  in virtio_gpio_probe()
552 	vgpio->lines = devm_kcalloc(dev, ngpio, sizeof(*vgpio->lines), GFP_KERNEL);  in virtio_gpio_probe()
553 	if (!vgpio->lines)  in virtio_gpio_probe()
554 		return -ENOMEM;  in virtio_gpio_probe()
557 		mutex_init(&vgpio->lines[i].lock);  in virtio_gpio_probe()
558 		init_completion(&vgpio->lines[i].completion);  in virtio_gpio_probe()
561 	mutex_init(&vgpio->lock);  in virtio_gpio_probe()
562 	vdev->priv = vgpio;  in virtio_gpio_probe()
564 	vgpio->vdev			= vdev;  in virtio_gpio_probe()
565 	vgpio->gc.free			= virtio_gpio_free;  in virtio_gpio_probe()
566 	vgpio->gc.get_direction		= virtio_gpio_get_direction;  in virtio_gpio_probe()
567 	vgpio->gc.direction_input	= virtio_gpio_direction_input;  in virtio_gpio_probe()
568 	vgpio->gc.direction_output	= virtio_gpio_direction_output;  in virtio_gpio_probe()
569 	vgpio->gc.get			= virtio_gpio_get;  in virtio_gpio_probe()
570 	vgpio->gc.set			= virtio_gpio_set;  in virtio_gpio_probe()
571 	vgpio->gc.ngpio			= ngpio;  in virtio_gpio_probe()
572 	vgpio->gc.base			= -1; /* Allocate base dynamically */  in virtio_gpio_probe()
573 	vgpio->gc.label			= dev_name(dev);  in virtio_gpio_probe()
574 	vgpio->gc.parent		= dev;  in virtio_gpio_probe()
575 	vgpio->gc.owner			= THIS_MODULE;  in virtio_gpio_probe()
576 	vgpio->gc.can_sleep		= true;  in virtio_gpio_probe()
580 		vgpio->irq_lines = devm_kcalloc(dev, ngpio, sizeof(*vgpio->irq_lines), GFP_KERNEL);  in virtio_gpio_probe()
581 		if (!vgpio->irq_lines)  in virtio_gpio_probe()
582 			return -ENOMEM;  in virtio_gpio_probe()
586 			return -ENOMEM;  in virtio_gpio_probe()
588 		gpio_irq_chip->name = dev_name(dev);  in virtio_gpio_probe()
589 		gpio_irq_chip->irq_enable = virtio_gpio_irq_enable;  in virtio_gpio_probe()
590 		gpio_irq_chip->irq_disable = virtio_gpio_irq_disable;  in virtio_gpio_probe()
591 		gpio_irq_chip->irq_mask = virtio_gpio_irq_mask;  in virtio_gpio_probe()
592 		gpio_irq_chip->irq_unmask = virtio_gpio_irq_unmask;  in virtio_gpio_probe()
593 		gpio_irq_chip->irq_set_type = virtio_gpio_irq_set_type;  in virtio_gpio_probe()
594 		gpio_irq_chip->irq_bus_lock = virtio_gpio_irq_bus_lock;  in virtio_gpio_probe()
595 		gpio_irq_chip->irq_bus_sync_unlock = virtio_gpio_irq_bus_sync_unlock;  in virtio_gpio_probe()
597 		/* The event comes from the outside so no parent handler */  in virtio_gpio_probe()
598 		vgpio->gc.irq.parent_handler	= NULL;  in virtio_gpio_probe()
599 		vgpio->gc.irq.num_parents	= 0;  in virtio_gpio_probe()
600 		vgpio->gc.irq.parents		= NULL;  in virtio_gpio_probe()
601 		vgpio->gc.irq.default_type	= IRQ_TYPE_NONE;  in virtio_gpio_probe()
602 		vgpio->gc.irq.handler		= handle_level_irq;  in virtio_gpio_probe()
603 		vgpio->gc.irq.chip		= gpio_irq_chip;  in virtio_gpio_probe()
606 			vgpio->irq_lines[i].type = VIRTIO_GPIO_IRQ_TYPE_NONE;  in virtio_gpio_probe()
607 			vgpio->irq_lines[i].disabled = true;  in virtio_gpio_probe()
608 			vgpio->irq_lines[i].masked = true;  in virtio_gpio_probe()
611 		mutex_init(&vgpio->irq_lock);  in virtio_gpio_probe()
612 		raw_spin_lock_init(&vgpio->eventq_lock);  in virtio_gpio_probe()
622 	vgpio->gc.names = virtio_gpio_get_names(vgpio, gpio_names_size, ngpio);  in virtio_gpio_probe()
624 	ret = gpiochip_add_data(&vgpio->gc, vgpio);  in virtio_gpio_probe()
627 		dev_err(dev, "Failed to add virtio-gpio controller\n");  in virtio_gpio_probe()
635 	struct virtio_gpio *vgpio = vdev->priv;  in virtio_gpio_remove()
637 	gpiochip_remove(&vgpio->gc);  in virtio_gpio_remove()
665 MODULE_DESCRIPTION("VirtIO GPIO driver");