freebsd-dev/sys/dev/ofw/openfirmio.h
Brandon Bergren 26869ad14c [PowerPC] Allow traversal of oversize OF properties.
In standards such as LoPAPR, property names in excess of the usual 31
characters exist.

This breaks property traversal.

While in IEEE 1275-1994, nextprop is defined explicitly to work with a
32-byte region of memory, using a larger buffer should be fine. There is
actually no way to pass a buffer length to the nextprop call in the OF
client interface, so SLOF actually just blindly overflows the buffer.

So we have to defensively make the buffer larger, to avoid memory
corruption when reading out long properties on live OF systems.

Note also that on real-mode OF, things are pretty tight because we are
allocating against a static bounce buffer in low memory, so we can't just
use a huge buffer to work around this without it being wasteful of our
limited amount of 32-bit physical memory.

This allows a patched ofwdump to operate properly on SLOF (i.e. pseries)
systems, as well as any other PowerPC systems with overlength properties.

Reviewed by:	jhibbits
MFC after:	2 weeks
Sponsored by:	Tag1 Consulting, Inc.
Differential Revision:	https://reviews.freebsd.org/D26669
2020-11-13 16:49:41 +00:00

94 lines
3.7 KiB
C

/* $NetBSD: openfirmio.h,v 1.4 2002/09/06 13:23:19 gehenna Exp $ */
/*-
* SPDX-License-Identifier: BSD-3-Clause
*
* 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.
* 3. 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 */
int of_namelen; /* length of of_name */
const char *of_name; /* pointer to field name */
int of_buflen; /* length of of_buf (value-result) */
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. */
#define OFIOCSET _IOWR(OFIOC_BASE, 2, struct ofiocdesc)
/* 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)
/* Retrieve the size of a property. */
#define OFIOCGETPROPLEN _IOWR(OFIOC_BASE, 8, struct ofiocdesc)
/* Maximum accepted name length. */
#define OFIOCMAXNAME 8191
/* Maximum accepted value length (maximum of nvramrc property). */
#define OFIOCMAXVALUE 8192
/*
* While IEEE 1275-1994 states in 3.2.2.1.1 that property names are 1-31
* printable characters, in practice, this limit has been ignored.
* Noncompliant properties have been codified in standards such as LoPAPR.
*
* This is a suggested buffer length that should be large enough to hold
* any property name currently seen in device trees, without being overly
* wasteful of memory.
*
* If a future version of the Devicetree specification updates the property
* names length requirement, this value will be updated to match.
*/
#define OFIOCSUGGPROPNAMELEN 64
#endif /* _DEV_OFW_OPENFIRMIO_H_ */