xref: /freebsd/sys/dev/gpio/pl061.h (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2020 Amazon.com, Inc. or its affiliates.
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 __DEV_PL061_H__
32 #define	__DEV_PL061_H__
33 
34 DECLARE_CLASS(pl061_driver);
35 
36 #define PL061_NUM_GPIO		8
37 
38 struct pl061_pin_irqsrc {
39 	struct intr_irqsrc	isrc;
40 	uint32_t		irq;
41 	uint32_t 		mode;
42 };
43 
44 struct pl061_softc {
45 	device_t		sc_dev;
46 	device_t		sc_busdev;
47 	struct mtx		sc_mtx;
48 	struct resource		*sc_mem_res;
49 	struct resource		*sc_irq_res;
50 	void			*sc_irq_hdlr;
51 	int			sc_mem_rid;
52 	int			sc_irq_rid;
53 	struct pl061_pin_irqsrc sc_isrcs[PL061_NUM_GPIO];
54 };
55 
56 int pl061_attach(device_t);
57 int pl061_detach(device_t);
58 
59 #endif /* __DEV_PL061_H__ */
60