/* $NetBSD: gpiovar.h,v 1.20 2024/12/08 20:40:38 jmcneill Exp $ */
/*	$OpenBSD: gpiovar.h,v 1.3 2006/01/14 12:33:49 grange Exp $	*/

/*
 * Copyright (c) 2004, 2006 Alexander Yurchenko <grange@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _DEV_GPIO_GPIOVAR_H_
#define _DEV_GPIO_GPIOVAR_H_

#include <sys/device.h>

/* GPIO controller description */
typedef struct gpio_chipset_tag {
	void	*gp_cookie;

	int	(*gp_gc_open)(void *, device_t);
	void    (*gp_gc_close)(void *, device_t);
	int	(*gp_pin_read)(void *, int);
	void	(*gp_pin_write)(void *, int, int);
	void	(*gp_pin_ctl)(void *, int, int);

	void *	(*gp_intr_establish)(void *, int, int, int,
				     int (*)(void *), void *);
	void	(*gp_intr_disestablish)(void *, void *);
	bool	(*gp_intr_str)(void *, int, int, char *, size_t);
	void	(*gp_intr_mask)(void *, void *);
	void	(*gp_intr_unmask)(void *, void *);
} *gpio_chipset_tag_t;

/* GPIO pin description */
typedef struct gpio_pin {
	int			pin_num;	/* number */
	int			pin_caps;	/* capabilities */
	int			pin_flags;	/* current configuration */
	int			pin_state;	/* current state */
	int			pin_mapped;	/* is mapped */
	gpio_chipset_tag_t	pin_gc;		/* reference the controller */
	char			pin_defname[GPIOMAXNAME]; /* default name */
	int			pin_intrcaps;	/* interrupt capabilities */
} gpio_pin_t;

/* Attach GPIO framework to the controller */
struct gpiobus_attach_args {
	gpio_chipset_tag_t	 gba_gc;	/* underlying controller */
	gpio_pin_t		*gba_pins;	/* pins array */
	int			 gba_npins;	/* total number of pins */
};

int gpiobus_print(void *, const char *);

/* GPIO framework private methods */
#define gpiobus_open(gc, dev) \
    ((gc)->gp_gc_open ? ((gc)->gp_gc_open((gc)->gp_cookie, dev)) : 0)
#define gpiobus_close(gc, dev) \
    ((gc)->gp_gc_close ? ((gc)->gp_gc_close((gc)->gp_cookie, dev)), 1 : 0)
#define gpiobus_pin_read(gc, pin) \
    ((gc)->gp_pin_read((gc)->gp_cookie, (pin)))
#define gpiobus_pin_write(gc, pin, value) \
    ((gc)->gp_pin_write((gc)->gp_cookie, (pin), (value)))
#define gpiobus_pin_ctl(gc, pin, flags) \
    ((gc)->gp_pin_ctl((gc)->gp_cookie, (pin), (flags)))

/* Attach devices connected to the GPIO pins */
struct gpio_attach_args {
	void		*ga_gpio;
	int		 ga_offset;
	uint32_t	 ga_mask;
	char		*ga_dvname;
	uint32_t	 ga_flags;	/* driver-specific flags */
};

/* GPIO pin map */
struct gpio_pinmap {
	int		*pm_map;		/* pin map */
	int		 pm_size;		/* map size */
};

struct gpio_dev {
	device_t		sc_dev;	/* the gpio device */
	LIST_ENTRY(gpio_dev)	sc_next;
};

struct gpio_name {
	char			gp_name[GPIOMAXNAME];
	int			gp_pin;
	LIST_ENTRY(gpio_name)	gp_next;
};

void *	gpio_find_device(const char *);
const char * gpio_get_name(void *gpio);
int	gpio_pin_can_map(void *, int, uint32_t);
int	gpio_pin_map(void *, int, uint32_t, struct gpio_pinmap *);
void	gpio_pin_unmap(void *, struct gpio_pinmap *);
int	gpio_pin_read(void *, struct gpio_pinmap *, int);
void	gpio_pin_write(void *, struct gpio_pinmap *, int, int);
int	gpio_pin_caps(void *, struct gpio_pinmap *, int);
int	gpio_pin_get_conf(void *, struct gpio_pinmap *, int);
bool	gpio_pin_set_conf(void *, struct gpio_pinmap *, int, int);
void	gpio_pin_ctl(void *, struct gpio_pinmap *, int, int);
int	gpio_pin_intrcaps(void *, struct gpio_pinmap *, int);
bool	gpio_pin_irqmode_issupported(void *, struct gpio_pinmap *, int, int);
int	gpio_pin_wait(void *, int);
int	gpio_npins(uint32_t);

void *	gpio_intr_establish(void *, struct gpio_pinmap *, int, int, int,
			    int (*)(void *), void *);
void	gpio_intr_disestablish(void *, void *);
bool	gpio_intr_str(void *, struct gpio_pinmap *, int, int,
		      char *, size_t);
void	gpio_intr_mask(void *, void *);
void	gpio_intr_unmask(void *, void *);
int	gpio_pin_to_pin_num(void *, struct gpio_pinmap *, int);

int	gpio_lock(void *);
void	gpio_unlock(void *);

#endif	/* !_DEV_GPIO_GPIOVAR_H_ */