2002-10-18 15:23:43 +00:00
|
|
|
/* $NetBSD: openfirmio.h,v 1.4 2002/09/06 13:23:19 gehenna Exp $ */
|
|
|
|
|
|
2005-01-06 01:43:34 +00:00
|
|
|
/*-
|
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.
|
|
|
|
|
* 4. Neither the name of the University nor the names of its contributors
|
|
|
|
|
* 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 */
|
2005-05-19 15:22:16 +00:00
|
|
|
int of_namelen; /* length of of_name */
|
2002-10-18 15:23:43 +00:00
|
|
|
const char *of_name; /* pointer to field name */
|
2005-05-19 15:22:16 +00:00
|
|
|
int of_buflen; /* length of of_buf (value-result) */
|
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)
|
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)
|
2003-06-11 18:33:03 +00:00
|
|
|
/* Retrieve the size of a property. */
|
|
|
|
|
#define OFIOCGETPROPLEN _IOWR(OFIOC_BASE, 8, struct ofiocdesc)
|
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
|
|
|
|
|
|
2002-10-18 15:23:43 +00:00
|
|
|
#endif /* _DEV_OFW_OPENFIRMIO_H_ */
|
