xref: /freebsd/sys/dev/iicbus/pmic/act8846.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2019 Michal Meloun <mmel@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _ACT8846_H_
32 #define _ACT8846_H_
33 
34 #include <dev/iicbus/pmic/act8846_reg.h>
35 
36 struct act8846_reg_sc;
37 struct act8846_gpio_pin;
38 
39 struct act8846_softc {
40 	device_t		dev;
41 	struct sx		lock;
42 	int			bus_addr;
43 
44 	/* Regulators. */
45 	struct act8846_reg_sc	**regs;
46 	int			nregs;
47 };
48 
49 #define	RD1(sc, reg, val)	act8846_read(sc, reg, val)
50 #define	WR1(sc, reg, val)	act8846_write(sc, reg, val)
51 #define	RM1(sc, reg, clr, set)	act8846_modify(sc, reg, clr, set)
52 
53 int act8846_read(struct act8846_softc *sc, uint8_t reg, uint8_t *val);
54 int act8846_write(struct act8846_softc *sc, uint8_t reg, uint8_t val);
55 int act8846_modify(struct act8846_softc *sc, uint8_t reg, uint8_t clear,
56     uint8_t set);
57 int act8846_read_buf(struct act8846_softc *sc, uint8_t reg, uint8_t *buf,
58     size_t size);
59 int act8846_write_buf(struct act8846_softc *sc, uint8_t reg, uint8_t *buf,
60     size_t size);
61 
62 /* Regulators */
63 int act8846_regulator_attach(struct act8846_softc *sc, phandle_t node);
64 int act8846_regulator_map(device_t dev, phandle_t xref, int ncells,
65     pcell_t *cells, int *num);
66 
67 #endif /* _ACT8846_H_ */
68