xref: /freebsd/sys/dev/ofw/openfirmio.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*	$NetBSD: openfirmio.h,v 1.4 2002/09/06 13:23:19 gehenna Exp $ */
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 1992, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * This software was developed by the Computer Systems Engineering group
10  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
11  * contributed to Berkeley.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #ifndef _DEV_OFW_OPENFIRMIO_H_
39 #define _DEV_OFW_OPENFIRMIO_H_
40 
41 #include <dev/ofw/openfirm.h>
42 
43 struct ofiocdesc {
44 	phandle_t	of_nodeid;	/* passed or returned node id */
45 	int		of_namelen;	/* length of of_name */
46 	const char	*of_name;	/* pointer to field name */
47 	int		of_buflen;	/* length of of_buf (value-result) */
48 	char		*of_buf;	/* pointer to field value */
49 };
50 
51 #define	OFIOC_BASE	'O'
52 
53 /* Get openprom field. */
54 #define	OFIOCGET	_IOWR(OFIOC_BASE, 1, struct ofiocdesc)
55 /* Set openprom field. */
56 #define	OFIOCSET	_IOWR(OFIOC_BASE, 2, struct ofiocdesc)
57 /* Get next property. */
58 #define	OFIOCNEXTPROP	_IOWR(OFIOC_BASE, 3, struct ofiocdesc)
59 /* Get options node. */
60 #define	OFIOCGETOPTNODE	_IOR(OFIOC_BASE, 4, phandle_t)
61 /* Get next node of node. */
62 #define	OFIOCGETNEXT	_IOWR(OFIOC_BASE, 5, phandle_t)
63 /* Get first child of node. */
64 #define	OFIOCGETCHILD	_IOWR(OFIOC_BASE, 6, phandle_t)
65 /* Find a specific device. */
66 #define	OFIOCFINDDEVICE	_IOWR(OFIOC_BASE, 7, struct ofiocdesc)
67 /* Retrieve the size of a property. */
68 #define	OFIOCGETPROPLEN	_IOWR(OFIOC_BASE, 8, struct ofiocdesc)
69 
70 /* Maximum accepted name length. */
71 #define	OFIOCMAXNAME	8191
72 /* Maximum accepted value length (maximum of nvramrc property). */
73 #define	OFIOCMAXVALUE	8192
74 
75 /*
76  * While IEEE 1275-1994 states in 3.2.2.1.1 that property names are 1-31
77  * printable characters, in practice, this limit has been ignored.
78  * Noncompliant properties have been codified in standards such as LoPAPR.
79  *
80  * This is a suggested buffer length that should be large enough to hold
81  * any property name currently seen in device trees, without being overly
82  * wasteful of memory.
83  *
84  * If a future version of the Devicetree specification updates the property
85  * names length requirement, this value will be updated to match.
86  */
87 #define	OFIOCSUGGPROPNAMELEN	64
88 
89 #endif /* _DEV_OFW_OPENFIRMIO_H_ */
90