d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
94140f4781
freebsd-dev/sys/dev/ofw/openfirmio.h

80 lines
3.1 KiB
C
Raw Normal View History

Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
/* $NetBSD: openfirmio.h,v 1.4 2002/09/06 13:23:19 gehenna Exp $ */
Start each of the license/copyright comments with /*-, minor shuffle of lines
2005-01-06 01:43:34 +00:00
/*-
sys/dev: further adoption of SPDX licensing ID tags. Mainly focus on files that use BSD 3-Clause license. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. Special thanks to Wind River for providing access to "The Duke of Highlander" tool: an older (2014) run over FreeBSD tree was useful as a starting point.
2017-11-20 19:36:21 +00:00
* SPDX-License-Identifier: BSD-3-Clause
*
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
* Copyright (c) 1992, 1993
* The Regents of the University of California. All rights reserved.
*
* This software was developed by the Computer Systems Engineering group
* at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
* contributed to Berkeley.
*
* 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.
* 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.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
* 3. Neither the name of the University nor the names of its contributors
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
*
* @(#)openpromio.h 8.1 (Berkeley) 6/11/93
*
* $FreeBSD$
*/
#ifndef _DEV_OFW_OPENFIRMIO_H_
#define _DEV_OFW_OPENFIRMIO_H_
#include <dev/ofw/openfirm.h>
struct ofiocdesc {
phandle_t of_nodeid; /* passed or returned node id */
Update the names of some member variables in comments to refect reality. Apparently this was forgotten when this code was derived from the BSD openprom(4).
2005-05-19 15:22:16 +00:00
int of_namelen; /* length of of_name */
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
const char *of_name; /* pointer to field name */
Update the names of some member variables in comments to refect reality. Apparently this was forgotten when this code was derived from the BSD openprom(4).
2005-05-19 15:22:16 +00:00
int of_buflen; /* length of of_buf (value-result) */
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
char *of_buf; /* pointer to field value */
};
#define OFIOC_BASE 'O'
/* Get openprom field. */
#define OFIOCGET _IOWR(OFIOC_BASE, 1, struct ofiocdesc)
/* Set openprom field. */
- Move OFW_NAME_MAX, used as a limit for OFW property names and device identifiers, to openfirmio.h as OFIOCMAXNAME, so programs can use it for buffer sizes etc. Note: Although this is only a rough upper limit to make the code more robust and to prevent the allocation of ridiculous amounts of memory, the current limit of one page (8191 + '\0' in openfirm_getstr()) still appears a bit high. The maximum length of OFW property names is 31. I didn't find a maximum length for the device identifiers in the OFW documentation but it certainly is much smaller than 8191, too. - Enable the OFIOCSET ioctl, i.e. move it out from under #if 0. - Don't use openfirm_getstr() for the property value in OFIOCSET, there are also properties whose values aren't strings and it makes sense to use a different maximum length for property values than OFW_NAME_MAX/ OFIOCMAXNAME. The maximum accepted property value is defined in openfirmio.h as OFIOCMAXVALUE (currently the maximum size of the value of the nvramrc property). - Make OFIOCSET not return EINVAL when OF_setprop() returns a different length for the written value than it was told to write, this is normal for the text string values of the properties in the OFW /options node. Instead, only return EINVAL if OF_setprop() returned -1 (value could not be written or property could not be created). Add a comment about the specialty of the OFW /options node. - Make OFIOCSET return the length of the written value returned by OF_setprop(), just like OF_getprop() does. Quite useful, at least for debugging. Reviewed by: tmm
2004-05-22 16:43:42 +00:00
#define OFIOCSET _IOWR(OFIOC_BASE, 2, struct ofiocdesc)
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
/* Get next property. */
#define OFIOCNEXTPROP _IOWR(OFIOC_BASE, 3, struct ofiocdesc)
/* Get options node. */
#define OFIOCGETOPTNODE _IOR(OFIOC_BASE, 4, phandle_t)
/* Get next node of node. */
#define OFIOCGETNEXT _IOWR(OFIOC_BASE, 5, phandle_t)
/* Get first child of node. */
#define OFIOCGETCHILD _IOWR(OFIOC_BASE, 6, phandle_t)
/* Find a specific device. */
#define OFIOCFINDDEVICE _IOWR(OFIOC_BASE, 7, struct ofiocdesc)
- Add an OFIOCGETPROPLEN ioctl() to get the length of a property. - Do not use a fixed major. - Minor cleanups.
2003-06-11 18:33:03 +00:00
/* Retrieve the size of a property. */
#define OFIOCGETPROPLEN _IOWR(OFIOC_BASE, 8, struct ofiocdesc)
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
- Move OFW_NAME_MAX, used as a limit for OFW property names and device identifiers, to openfirmio.h as OFIOCMAXNAME, so programs can use it for buffer sizes etc. Note: Although this is only a rough upper limit to make the code more robust and to prevent the allocation of ridiculous amounts of memory, the current limit of one page (8191 + '\0' in openfirm_getstr()) still appears a bit high. The maximum length of OFW property names is 31. I didn't find a maximum length for the device identifiers in the OFW documentation but it certainly is much smaller than 8191, too. - Enable the OFIOCSET ioctl, i.e. move it out from under #if 0. - Don't use openfirm_getstr() for the property value in OFIOCSET, there are also properties whose values aren't strings and it makes sense to use a different maximum length for property values than OFW_NAME_MAX/ OFIOCMAXNAME. The maximum accepted property value is defined in openfirmio.h as OFIOCMAXVALUE (currently the maximum size of the value of the nvramrc property). - Make OFIOCSET not return EINVAL when OF_setprop() returns a different length for the written value than it was told to write, this is normal for the text string values of the properties in the OFW /options node. Instead, only return EINVAL if OF_setprop() returned -1 (value could not be written or property could not be created). Add a comment about the specialty of the OFW /options node. - Make OFIOCSET return the length of the written value returned by OF_setprop(), just like OF_getprop() does. Quite useful, at least for debugging. Reviewed by: tmm
2004-05-22 16:43:42 +00:00
/* Maximum accepted name length. */
#define OFIOCMAXNAME 8191
/* Maximum accepted value length (maximum of nvramrc property). */
#define OFIOCMAXVALUE 8192
Add a pseudo device which allows to access the OpenFirmware device tree via ioctl()s. This was ported from NetBSD and adapted a bit to better match our OpenFirmware support code.
2002-10-18 15:23:43 +00:00
#endif /* _DEV_OFW_OPENFIRMIO_H_ */
Reference in New Issue Copy Permalink