2005-11-22 16:37:45 +00:00
|
|
|
/*-
|
2017-11-27 14:52:40 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
|
|
*
|
2005-11-22 16:37:45 +00:00
|
|
|
* Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions, and the following disclaimer,
|
|
|
|
* without modification, immediately at the beginning of the file.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in
|
|
|
|
* the documentation and/or other materials provided with the
|
|
|
|
* distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
|
|
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* $FreeBSD$
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _DEV_OFW_OFW_BUS_SUBR_H_
|
|
|
|
#define _DEV_OFW_OFW_BUS_SUBR_H_
|
|
|
|
|
|
|
|
#include <sys/bus.h>
|
2016-08-19 10:52:39 +00:00
|
|
|
#ifdef INTRNG
|
|
|
|
#include <sys/intr.h>
|
|
|
|
#endif
|
2005-11-22 16:37:45 +00:00
|
|
|
#include <dev/ofw/openfirm.h>
|
|
|
|
|
|
|
|
#include "ofw_bus_if.h"
|
|
|
|
|
2008-12-15 15:31:10 +00:00
|
|
|
#define ORIP_NOINT -1
|
|
|
|
#define ORIR_NOTFOUND 0xffffffff
|
|
|
|
|
|
|
|
struct ofw_bus_iinfo {
|
2009-06-14 00:05:38 +00:00
|
|
|
uint8_t *opi_imap;
|
|
|
|
uint8_t *opi_imapmsk;
|
2008-12-15 15:31:10 +00:00
|
|
|
int opi_imapsz;
|
|
|
|
pcell_t opi_addrc;
|
|
|
|
};
|
|
|
|
|
2013-10-25 19:15:21 +00:00
|
|
|
struct ofw_compat_data {
|
|
|
|
const char *ocd_str;
|
|
|
|
uintptr_t ocd_data;
|
|
|
|
};
|
|
|
|
|
2016-08-19 10:52:39 +00:00
|
|
|
#ifdef INTRNG
|
2016-06-05 16:20:12 +00:00
|
|
|
struct intr_map_data_fdt {
|
|
|
|
struct intr_map_data hdr;
|
|
|
|
phandle_t iparent;
|
|
|
|
u_int ncells;
|
2016-08-19 10:52:39 +00:00
|
|
|
pcell_t cells[];
|
2016-06-05 16:20:12 +00:00
|
|
|
};
|
2016-08-19 10:52:39 +00:00
|
|
|
#endif
|
2016-06-05 16:20:12 +00:00
|
|
|
|
2019-05-23 15:47:30 +00:00
|
|
|
#define FDTCOMPAT_PNP_DESCR "Z:compat;P:#;"
|
|
|
|
#define FDTCOMPAT_PNP_INFO(t, busname) \
|
|
|
|
MODULE_PNP_INFO(FDTCOMPAT_PNP_DESCR, busname, t, t, sizeof(t) / sizeof(t[0]));
|
|
|
|
|
|
|
|
#define SIMPLEBUS_PNP_INFO(t) FDTCOMPAT_PNP_INFO(t, simplebus)
|
2015-12-18 05:29:22 +00:00
|
|
|
|
2009-06-14 00:05:38 +00:00
|
|
|
/* Generic implementation of ofw_bus_if.m methods and helper routines */
|
2005-11-22 16:37:45 +00:00
|
|
|
int ofw_bus_gen_setup_devinfo(struct ofw_bus_devinfo *, phandle_t);
|
|
|
|
void ofw_bus_gen_destroy_devinfo(struct ofw_bus_devinfo *);
|
|
|
|
|
2009-06-14 00:05:38 +00:00
|
|
|
ofw_bus_get_compat_t ofw_bus_gen_get_compat;
|
|
|
|
ofw_bus_get_model_t ofw_bus_gen_get_model;
|
|
|
|
ofw_bus_get_name_t ofw_bus_gen_get_name;
|
|
|
|
ofw_bus_get_node_t ofw_bus_gen_get_node;
|
|
|
|
ofw_bus_get_type_t ofw_bus_gen_get_type;
|
|
|
|
|
2008-12-15 15:31:10 +00:00
|
|
|
/* Helper method to report interesting OF properties in pnpinfo */
|
2009-06-14 00:05:38 +00:00
|
|
|
bus_child_pnpinfo_str_t ofw_bus_gen_child_pnpinfo_str;
|
2008-12-15 15:31:10 +00:00
|
|
|
|
|
|
|
/* Routines for processing firmware interrupt maps */
|
|
|
|
void ofw_bus_setup_iinfo(phandle_t, struct ofw_bus_iinfo *, int);
|
|
|
|
int ofw_bus_lookup_imap(phandle_t, struct ofw_bus_iinfo *, void *, int,
|
2013-12-17 15:11:24 +00:00
|
|
|
void *, int, void *, int, phandle_t *);
|
2008-12-15 15:31:10 +00:00
|
|
|
int ofw_bus_search_intrmap(void *, int, void *, int, void *, int, void *,
|
2010-06-18 14:06:27 +00:00
|
|
|
void *, void *, int, phandle_t *);
|
|
|
|
|
2016-05-16 09:31:44 +00:00
|
|
|
/* Routines for processing msi maps */
|
|
|
|
int ofw_bus_msimap(phandle_t, uint16_t, phandle_t *, uint32_t *);
|
|
|
|
|
2014-09-25 15:02:33 +00:00
|
|
|
/* Routines for parsing device-tree data into resource lists. */
|
2015-01-13 00:00:09 +00:00
|
|
|
int ofw_bus_reg_to_rl(device_t, phandle_t, pcell_t, pcell_t,
|
|
|
|
struct resource_list *);
|
2018-04-04 12:47:41 +00:00
|
|
|
int ofw_bus_assigned_addresses_to_rl(device_t, phandle_t, pcell_t, pcell_t,
|
|
|
|
struct resource_list *);
|
2015-05-15 13:55:18 +00:00
|
|
|
int ofw_bus_intr_to_rl(device_t, phandle_t, struct resource_list *, int *);
|
2016-06-05 16:20:12 +00:00
|
|
|
int ofw_bus_intr_by_rid(device_t, phandle_t, int, phandle_t *, int *,
|
|
|
|
pcell_t **);
|
2014-09-25 15:02:33 +00:00
|
|
|
|
2014-02-02 16:41:54 +00:00
|
|
|
/* Helper to get device status property */
|
|
|
|
const char *ofw_bus_get_status(device_t dev);
|
|
|
|
int ofw_bus_status_okay(device_t dev);
|
2017-01-25 10:28:21 +00:00
|
|
|
int ofw_bus_node_status_okay(phandle_t node);
|
2014-02-02 16:41:54 +00:00
|
|
|
|
2010-06-18 14:06:27 +00:00
|
|
|
/* Helper to get node's interrupt parent */
|
2015-12-02 14:21:16 +00:00
|
|
|
phandle_t ofw_bus_find_iparent(phandle_t);
|
2008-12-15 15:31:10 +00:00
|
|
|
|
2010-05-28 10:43:56 +00:00
|
|
|
/* Helper routine for checking compat prop */
|
|
|
|
int ofw_bus_is_compatible(device_t, const char *);
|
|
|
|
int ofw_bus_is_compatible_strict(device_t, const char *);
|
2016-08-28 21:31:21 +00:00
|
|
|
int ofw_bus_node_is_compatible(phandle_t, const char *);
|
2010-05-28 10:43:56 +00:00
|
|
|
|
2013-10-25 19:15:21 +00:00
|
|
|
/*
|
|
|
|
* Helper routine to search a list of compat properties. The table is
|
|
|
|
* terminated by an entry with a NULL compat-string pointer; a pointer to that
|
|
|
|
* table entry is returned if none of the compat strings match for the device,
|
|
|
|
* giving you control over the not-found value. Will not return NULL unless the
|
|
|
|
* provided table pointer is NULL.
|
|
|
|
*/
|
|
|
|
const struct ofw_compat_data *
|
|
|
|
ofw_bus_search_compatible(device_t, const struct ofw_compat_data *);
|
|
|
|
|
2012-08-18 11:25:07 +00:00
|
|
|
/* Helper routine for checking existence of a prop */
|
|
|
|
int ofw_bus_has_prop(device_t, const char *);
|
|
|
|
|
2015-05-11 15:47:55 +00:00
|
|
|
/* Helper to search for a child with a given compat prop */
|
|
|
|
phandle_t ofw_bus_find_compatible(phandle_t, const char *);
|
|
|
|
|
2015-05-24 23:53:10 +00:00
|
|
|
/* Helper to search for a child with a given name */
|
|
|
|
phandle_t ofw_bus_find_child(phandle_t, const char *);
|
|
|
|
|
2016-05-26 16:53:50 +00:00
|
|
|
/* Helper routine to find a device_t child matching a given phandle_t */
|
2015-06-20 04:48:48 +00:00
|
|
|
device_t ofw_bus_find_child_device_by_phandle(device_t bus, phandle_t node);
|
|
|
|
|
2015-12-13 08:17:49 +00:00
|
|
|
/* Helper routines for parsing lists */
|
|
|
|
int ofw_bus_parse_xref_list_alloc(phandle_t node, const char *list_name,
|
|
|
|
const char *cells_name, int idx, phandle_t *producer, int *ncells,
|
|
|
|
pcell_t **cells);
|
2016-02-09 03:35:40 +00:00
|
|
|
int ofw_bus_parse_xref_list_get_length(phandle_t node, const char *list_name,
|
|
|
|
const char *cells_name, int *count);
|
2015-12-13 08:17:49 +00:00
|
|
|
int ofw_bus_find_string_index(phandle_t node, const char *list_name,
|
|
|
|
const char *name, int *idx);
|
|
|
|
int ofw_bus_string_list_to_array(phandle_t node, const char *list_name,
|
|
|
|
const char ***array);
|
|
|
|
|
2005-11-22 16:37:45 +00:00
|
|
|
#endif /* !_DEV_OFW_OFW_BUS_SUBR_H_ */
|