include/rtems/rtems-fdt-shell.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  *  COPYRIGHT (c) 2013-2017 Chris Johns <chrisj@rtems.org>
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027 /**
0028  * @file
0029  *
0030  * @ingroup rtems_fdt
0031  *
0032  * @brief RTEMS Flattened Device Tree Shell Command
0033  *
0034  * Support for loading, managing and accessing FDT blobs in RTEMS.
0035  */
0036
0037 #if !defined (_RTEMS_FDT_SHELL_H_)
0038 #define _RTEMS_FDT_SHELL_H_
0039
0040 #include <rtems/rtems-fdt.h>
0041
0042 #ifdef __cplusplus
0043 extern "C" {
0044 #endif /* __cplusplus */
0045
0046 /**
0047  * Add a shell command to access memory and registers associated with the DTF.
0048  */
0049 void rtems_fdt_add_shell_command (void);
0050
0051 /**
0052  * Get a pointer to the handle. You can use this to load files or register
0053  * blobs and have the shell command access them.
0054  */
0055 rtems_fdt_handle* rtems_fdt_get_shell_handle (void);
0056
0057 /**
0058  * Write handler call to write from the address property.
0059  */
0060 typedef void (*rtems_fdt_write_handler)(uintptr_t address, uint32_t value);
0061
0062 /**
0063  * Read handler call to read from the address property.
0064  */
0065 typedef uint32_t (*rtems_fdt_read_handler)(uintptr_t address);
0066
0067 /**
0068  * Set the write handler returning the current handler.
0069  */
0070 rtems_fdt_write_handler
0071 rtems_fdt_set_shell_write_handler (rtems_fdt_write_handler handler);
0072
0073 /**
0074  * Set the read handler returning the current handler.
0075  */
0076 rtems_fdt_read_handler
0077 rtems_fdt_set_shell_read_handler (rtems_fdt_read_handler handler);
0078
0079 #ifdef __cplusplus
0080 }
0081 #endif /* __cplusplus */
0082
0083 #endif