ofw_bus_subr.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2005 Marius Strobl <marius@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 *    without modification, immediately at the beginning of the file.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in
15 *    the documentation and/or other materials provided with the
16 *    distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD: stable/11/sys/dev/ofw/ofw_bus_subr.h 330897 2018-03-14 03:19:51Z eadler $
31 */
32
33#ifndef	_DEV_OFW_OFW_BUS_SUBR_H_
34#define	_DEV_OFW_OFW_BUS_SUBR_H_
35
36#include <sys/bus.h>
37#ifdef INTRNG
38#include <sys/intr.h>
39#endif
40#include <dev/ofw/openfirm.h>
41
42#include "ofw_bus_if.h"
43
44#define	ORIP_NOINT	-1
45#define	ORIR_NOTFOUND	0xffffffff
46
47struct ofw_bus_iinfo {
48	uint8_t			*opi_imap;
49	uint8_t			*opi_imapmsk;
50	int			opi_imapsz;
51	pcell_t			opi_addrc;
52};
53
54struct ofw_compat_data {
55	const char	*ocd_str;
56	uintptr_t	 ocd_data;
57};
58
59#ifdef INTRNG
60struct intr_map_data_fdt {
61	struct intr_map_data	hdr;
62	phandle_t		iparent;
63	u_int			ncells;
64	pcell_t			cells[];
65};
66#endif
67
68#define SIMPLEBUS_PNP_DESCR "Z:compat;P:private;"
69#define SIMPLEBUS_PNP_INFO(t) \
70	MODULE_PNP_INFO(SIMPLEBUS_PNP_DESCR, simplebus, t, t, sizeof(t[0]), sizeof(t) / sizeof(t[0]));
71
72/* Generic implementation of ofw_bus_if.m methods and helper routines */
73int	ofw_bus_gen_setup_devinfo(struct ofw_bus_devinfo *, phandle_t);
74void	ofw_bus_gen_destroy_devinfo(struct ofw_bus_devinfo *);
75
76ofw_bus_get_compat_t	ofw_bus_gen_get_compat;
77ofw_bus_get_model_t	ofw_bus_gen_get_model;
78ofw_bus_get_name_t	ofw_bus_gen_get_name;
79ofw_bus_get_node_t	ofw_bus_gen_get_node;
80ofw_bus_get_type_t	ofw_bus_gen_get_type;
81
82/* Helper method to report interesting OF properties in pnpinfo */
83bus_child_pnpinfo_str_t	ofw_bus_gen_child_pnpinfo_str;
84
85/* Routines for processing firmware interrupt maps */
86void	ofw_bus_setup_iinfo(phandle_t, struct ofw_bus_iinfo *, int);
87int	ofw_bus_lookup_imap(phandle_t, struct ofw_bus_iinfo *, void *, int,
88	    void *, int, void *, int, phandle_t *);
89int	ofw_bus_search_intrmap(void *, int, void *, int, void *, int, void *,
90	    void *, void *, int, phandle_t *);
91
92/* Routines for processing msi maps */
93int ofw_bus_msimap(phandle_t, uint16_t, phandle_t *, uint32_t *);
94
95/* Routines for parsing device-tree data into resource lists. */
96int ofw_bus_reg_to_rl(device_t, phandle_t, pcell_t, pcell_t,
97    struct resource_list *);
98int ofw_bus_intr_to_rl(device_t, phandle_t, struct resource_list *, int *);
99int ofw_bus_intr_by_rid(device_t, phandle_t, int, phandle_t *, int *,
100    pcell_t **);
101
102/* Helper to get device status property */
103const char *ofw_bus_get_status(device_t dev);
104int ofw_bus_status_okay(device_t dev);
105
106/* Helper to get node's interrupt parent */
107phandle_t ofw_bus_find_iparent(phandle_t);
108
109/* Helper routine for checking compat prop */
110int ofw_bus_is_compatible(device_t, const char *);
111int ofw_bus_is_compatible_strict(device_t, const char *);
112int ofw_bus_node_is_compatible(phandle_t, const char *);
113
114/*
115 * Helper routine to search a list of compat properties.  The table is
116 * terminated by an entry with a NULL compat-string pointer; a pointer to that
117 * table entry is returned if none of the compat strings match for the device,
118 * giving you control over the not-found value.  Will not return NULL unless the
119 * provided table pointer is NULL.
120 */
121const struct ofw_compat_data *
122    ofw_bus_search_compatible(device_t, const struct ofw_compat_data *);
123
124/* Helper routine for checking existence of a prop */
125int ofw_bus_has_prop(device_t, const char *);
126
127/* Helper to search for a child with a given compat prop */
128phandle_t ofw_bus_find_compatible(phandle_t, const char *);
129
130/* Helper to search for a child with a given name */
131phandle_t ofw_bus_find_child(phandle_t, const char *);
132
133/* Helper routine to find a device_t child matching a given phandle_t */
134device_t ofw_bus_find_child_device_by_phandle(device_t bus, phandle_t node);
135
136/* Helper routines for parsing lists  */
137int ofw_bus_parse_xref_list_alloc(phandle_t node, const char *list_name,
138    const char *cells_name, int idx, phandle_t *producer, int *ncells,
139    pcell_t **cells);
140int ofw_bus_parse_xref_list_get_length(phandle_t node, const char *list_name,
141    const char *cells_name, int *count);
142int ofw_bus_find_string_index(phandle_t node, const char *list_name,
143    const char *name, int *idx);
144int ofw_bus_string_list_to_array(phandle_t node, const char *list_name,
145    const char ***array);
146
147#endif /* !_DEV_OFW_OFW_BUS_SUBR_H_ */
148