Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:23:42

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002 
0003 /*
0004  * Copyright (C) 2015, 2017 embedded brains GmbH & Co. KG
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 #ifndef LIBBSP_SHARED_FDT_H
0029 #define LIBBSP_SHARED_FDT_H
0030 
0031 #include <bsp.h>
0032 
0033 #ifdef __cplusplus
0034 extern "C" {
0035 #endif /* __cplusplus */
0036 
0037 /*
0038  * BSPs that implement the FDT support functions must define
0039  * BSP_FDT_IS_SUPPORTED.
0040  */
0041 
0042 /**
0043  * @brief Copies the specified source FDT to a dedicated global data area.
0044  *
0045  * The source FDT is usually provided by a bootloader and may be located in a
0046  * memory area that is used by the program.  The low-level initialization
0047  * should copy the FDT for later use.
0048  *
0049  * The copy can be accessed by bsp_fdt_get().
0050  *
0051  * @param[in] src The source FDT.
0052  */
0053 void bsp_fdt_copy(const void *src);
0054 
0055 /**
0056  * @brief Returns the FDT of the BSP.
0057  *
0058  * @return The FDT of the BSP.
0059  */
0060 const void *bsp_fdt_get(void);
0061 
0062 /**
0063  * @brief Maps the interrupt number of the FDT to the interrupt vector used by
0064  * the interrupt management.
0065  *
0066  * This function is used by the libbsd to implement the OFW_BUS_MAP_INTR bus
0067  * method.
0068  *
0069  * @param[in] intr The FDT interrupt number cells.
0070  * @param[in] icells The FDT interrupt cell count.
0071  *
0072  * @return The interrupt vector of the FDT interrupt number.
0073  */
0074 uint32_t bsp_fdt_map_intr(const uint32_t *intr, size_t icells);
0075 
0076 #ifdef __cplusplus
0077 }
0078 #endif /* __cplusplus */
0079 
0080 #endif /* LIBBSP_SHARED_FDT_H */