rtems-fdt.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 2013-2017 Chris Johns <chrisj@rtems.org>
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
 *
 *  Interface based on the libdft:
 *    libfdt - Flat Device Tree manipulation
 *    Copyright (C) 2006 David Gibson, IBM Corporation.
 */
#if !defined (_RTEMS_FDT_H_)
#define _RTEMS_FDT_H_
 
#include <rtems.h>
#include <rtems/chain.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
struct rtems_fdt_blob;
typedef struct rtems_fdt_blob rtems_fdt_blob;
 
typedef struct
{
  rtems_fdt_blob* blob;  
} rtems_fdt_handle;
 
typedef struct
{
  int node;
  uint64_t address;
  uint64_t size;
  int      address_cells;
  int      size_cells;
} rtems_fdt_address_map;
 
/*
 * The following are mappings to the standard FDT calls.
 */
 
#define RTEMS_FDT_ERR_NOTFOUND  1
#define RTEMS_FDT_ERR_EXISTS    2
#define RTEMS_FDT_ERR_NOSPACE    3
 
/* Error codes: codes for bad parameters */
#define RTEMS_FDT_ERR_BADOFFSET  4
#define RTEMS_FDT_ERR_BADPATH    5
#define RTEMS_FDT_ERR_BADPHANDLE  6
#define RTEMS_FDT_ERR_BADSTATE  7
 
/* Error codes: codes for bad device tree blobs */
 
#define RTEMS_FDT_ERR_TRUNCATED  8
#define RTEMS_FDT_ERR_BADMAGIC  9
#define RTEMS_FDT_ERR_BADVERSION  10
#define RTEMS_FDT_ERR_BADSTRUCTURE  11
#define RTEMS_FDT_ERR_BADLAYOUT  12
#define RTEMS_FDT_ERR_INTERNAL  13
 
/* RTEMS error codes. */
 
#define RTEMS_FDT_ERR_INVALID_HANDLE 100
#define RTEMS_FDT_ERR_NO_MEMORY      101
#define RTEMS_FDT_ERR_NOT_FOUND      102
#define RTEMS_FDT_ERR_READ_FAIL      103
#define RTEMS_FDT_ERR_REFERENCED     104
#define RTEMS_FDT_ERR_BADLENGTH      105
 
#define RTEMS_FDT_ERR_RTEMS_MIN      100
#define RTEMS_FDT_ERR_MAX            105
 
void rtems_fdt_init_handle (rtems_fdt_handle* handle);
 
void rtems_fdt_dup_handle (rtems_fdt_handle* from, rtems_fdt_handle* to);
 
void rtems_fdt_release_handle (rtems_fdt_handle* handle);
 
bool rtems_fdt_valid_handle (const rtems_fdt_handle* handle);
 
int rtems_fdt_find_path_offset (rtems_fdt_handle* handle, const char* path);
 
int rtems_fdt_load (const char* const filename, rtems_fdt_handle* handle);
 
int rtems_fdt_register (const void* blob, rtems_fdt_handle* handle);
 
int rtems_fdt_unload (rtems_fdt_handle* handle);
 
int rtems_fdt_num_mem_rsv (rtems_fdt_handle* handle);
 
int rtems_fdt_get_mem_rsv (rtems_fdt_handle* handle,
                           int               n,
                           uint64_t*         address,
                           uint64_t*         size);
 
int rtems_fdt_subnode_offset_namelen (rtems_fdt_handle* handle,
                                      int               parentoffset,
                                      const char* const name,
                                      int               namelen);
 
int rtems_fdt_subnode_offset (rtems_fdt_handle* handle,
                              int               parentoffset,
                              const char* const name);
 
int rtems_fdt_path_offset (rtems_fdt_handle* handle, const char* path);
 
const char* rtems_fdt_get_name (rtems_fdt_handle* handle,
                                int               nodeoffset,
                                int*              length);
 
int rtems_fdt_first_prop_offset(rtems_fdt_handle* handle, int nodeoffset);
 
int rtems_fdt_next_prop_offset(rtems_fdt_handle* handle, int propoffset);
 
const void* rtems_fdt_getprop_by_offset(rtems_fdt_handle* handle,
                                        int               propoffset,
                                        const char**      name,
                                        int*              length);
 
const void *rtems_fdt_getprop_namelen (rtems_fdt_handle* handle,
                                       int               nodeoffset,
                                       const char* const name,
                                       int               namelen,
                                       int*              length);
 
const void *rtems_fdt_getprop (rtems_fdt_handle* handle,
                               int               nodeoffset,
                               const char* const name,
                               int*              length);
 
uint32_t rtems_fdt_get_phandle (rtems_fdt_handle* handle, int nodeoffset);
 
const char *rtems_fdt_get_alias_namelen (rtems_fdt_handle* handle,
                                         const char* const name,
                                         int               namelen);
 
const char* rtems_fdt_get_alias (rtems_fdt_handle* handle, const char* name);
 
int rtems_fdt_get_path (rtems_fdt_handle* handle,
                        int               nodeoffset,
                        char*             buf,
                        int               buflen);
 
int rtems_fdt_supernode_atdepth_offset (rtems_fdt_handle* handle,
                                        int               nodeoffset,
                                        int               supernodedepth,
                                        int*              nodedepth);
 
int rtems_fdt_node_depth (rtems_fdt_handle* handle, int nodeoffset);
 
int rtems_fdt_parent_offset (rtems_fdt_handle* handle, int nodeoffset);
 
int rtems_fdt_node_offset_by_prop_value (rtems_fdt_handle* handle,
                                         int               startoffset,
                                         const char* const propname,
                                         const void*       propval,
                                         int               proplen);
 
int rtems_fdt_node_offset_by_phandle (rtems_fdt_handle* handle,
                                      uint32_t          phandle);
 
int rtems_fdt_node_check_compatible (rtems_fdt_handle* handle,
                                     int               nodeoffset,
                                     const char* const compatible);
 
int rtems_fdt_node_offset_by_compatible(rtems_fdt_handle* handle,
                                        int               startoffset,
                                        const char*       compatible);
 
int rtems_fdt_next_node (rtems_fdt_handle* handle, int offset, int* depth);
 
const char* rtems_fdt_strerror (int errval);
 
bool rtems_fdt_get_parent_prop_value(rtems_fdt_handle* handle,
                                     int               nodeoffset,
                                     const char*       name,
                                     uint32_t*         value);
int rtems_fdt_prop_value(const char* const path,
                         const char* const propname,
                         void*             value,
                         size_t*           size);
 
int rtems_fdt_prop_map (const char* const path,
                        const char* const propname,
                        const char* const names[],
                        uintptr_t*        values,
                        size_t            count);
 
/*
 * Get a value given a path and a property.
 */
int rtems_fdt_get_value (const char* const path,
                         const char* const property,
                         size_t            size,
                         uintptr_t*        value);
 
int rtems_fdt_num_entries(rtems_fdt_handle* handle);
 
const char *rtems_fdt_entry_name(rtems_fdt_handle* handle, int id);
 
int rtems_fdt_entry_offset(rtems_fdt_handle* handle, int id);
 
/*
 * Helper function to convert the void* property result of unknown
 * length to an unsigned int pointer value.
 */
uintptr_t rtems_fdt_get_offset_len_uintptr(const void* prop, int offset, int len);
 
/*
 * Helper function to convert the void* property result to a 32bit unsigned int.
 */
uint32_t rtems_fdt_get_uint32(const void* prop);
uint32_t rtems_fdt_get_offset_uint32(const void* prop, int offset);
 
/*
 * Helper function to convert the void* property result to a 64bit unsigned int.
 */
uint64_t rtems_fdt_get_uint64(const void* prop);
uint64_t rtems_fdt_get_offset_uint64(const void* prop, int offset);
 
/*
 * Helper function to convert the void* property result to a uintptr_t
 */
uintptr_t rtems_fdt_get_uintptr(const void* prop);
uintptr_t rtems_fdt_get_offset_uintptr(const void* prop, int offset);
 
/*
 * Find the address cells property in parent nodes.
 */
int rtems_fdt_getprop_address_cells(rtems_fdt_handle* handle, int nodeoffset);
 
/*
 * Find the size cells property in parent nodes.
 */
int rtems_fdt_getprop_size_cells(rtems_fdt_handle* handle, int nodeoffset);
 
/*
 * Get an address space property.
 */
int rtems_fdt_getprop_address_map(rtems_fdt_handle*      handle,
                                  const char*            path,
                                  const char*            name,
                                  rtems_fdt_address_map* addr_map);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif