ofw.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2020 Niteesh Babu G S <niteesh.gs@gmail.com>
 *
 * 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.
 */
 
#ifndef _OFW_H
#define _OFW_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <rtems.h>
#include <stdint.h>
#include <sys/types.h>
 
typedef uint32_t  phandle_t;
typedef uint32_t  ihandle_t;
typedef uint32_t  pcell_t;
 
typedef struct {
  uint32_t start;
  uint32_t size;
} rtems_ofw_memory_area;
 
typedef struct {
  uint32_t child_bus;
  uint32_t parent_bus;
  uint32_t size;
} rtems_ofw_ranges;
 
phandle_t rtems_ofw_peer(
  phandle_t   node
);
 
phandle_t rtems_ofw_child(
  phandle_t   node
);
 
phandle_t rtems_ofw_parent(
  phandle_t   node
);
 
ssize_t rtems_ofw_get_prop_len(
  phandle_t   node,
  const char *propname
);
 
ssize_t rtems_ofw_get_prop(
  phandle_t    node,
  const char  *propname,
  void        *buf,
  size_t       len
);
 
ssize_t rtems_ofw_get_enc_prop(
  phandle_t    node,
  const char  *prop,
  pcell_t     *buf,
  size_t       len
);
 
int rtems_ofw_has_prop(
  phandle_t    node,
  const char  *propname
);
 
ssize_t rtems_ofw_search_prop(
  phandle_t    node,
  const char  *propname,
  void        *buf,
  size_t       len
);
 
ssize_t rtems_ofw_search_enc_prop(
  phandle_t    node,
  const char  *propname,
  pcell_t     *buf,
  size_t       len
);
 
ssize_t rtems_ofw_get_prop_alloc(
  phandle_t    node,
  const char  *propname,
  void       **buf
);
 
ssize_t rtems_ofw_get_prop_alloc_multi(
  phandle_t    node,
  const char  *propname,
  int          elsz,
  void       **buf
);
 
ssize_t rtems_ofw_get_enc_prop_alloc(
  phandle_t    node,
  const char  *propname,
  void       **buf
);
 
ssize_t rtems_ofw_get_enc_prop_alloc_multi(
  phandle_t     node,
  const char   *propname,
  int           elsz,
  void        **buf
);
 
void rtems_ofw_free(
  void   *buf
);
 
int rtems_ofw_next_prop(
  phandle_t    node,
  const char  *previous,
  char        *buf,
  size_t       len
);
 
int rtems_ofw_set_prop(
  phandle_t    node,
  const char  *name,
  const void  *buf,
  size_t       len
);
 
ssize_t rtems_ofw_canon(
  const char  *dev,
  char        *buf,
  size_t       len
);
 
phandle_t rtems_ofw_find_device(
  const char  *path
);
 
phandle_t rtems_ofw_node_from_xref(
  phandle_t   xref
);
 
phandle_t rtems_ofw_xref_from_node(
  phandle_t   node
);
 
/*
 * instance handles(ihandle_t) as same as phandles in the FDT implementation
 * of OF interface.
 */
 
phandle_t rtems_ofw_instance_to_package(
  ihandle_t   instance
);
 
ssize_t rtems_ofw_package_to_path(
  phandle_t   node,
  char       *buf,
  size_t      len
);
 
ssize_t rtems_ofw_instance_to_path(
  ihandle_t  instance,
  char      *buf,
  size_t     len
);
 
int rtems_ofw_get_reg(
  phandle_t              node,
  rtems_ofw_memory_area *buf,
  size_t                 size
);
 
int rtems_ofw_get_interrupts(
  phandle_t            node,
  rtems_vector_number *buf,
  size_t               size
);
 
bool rtems_ofw_node_status( phandle_t node );
 
phandle_t rtems_ofw_find_device_by_compat( const char *compat );
 
bool rtems_ofw_is_node_compatible( phandle_t node, const char *compat );
 
#ifdef __cplusplus
}
#endif
 
#endif /* _OFW_H */