Line data    Source code

       1           1 : /*
       2             :  * Copyright (c) 2024 Intel Corporation
       3             :  *
       4             :  * SPDX-License-Identifier: Apache-2.0
       5             :  */
       6             : #ifndef ZEPHYR_INCLUDE_PLATFORM_PLATFORM_H_
       7             : #define ZEPHYR_INCLUDE_PLATFORM_PLATFORM_H_
       8             : 
       9             : /**
      10             :  * @file
      11             :  * @brief Soc and Board hooks
      12             :  *
      13             :  * This header file contains function prototypes for the interfaces between
      14             :  * zephyr architecture and initialization code and the SoC and board specific logic
      15             :  * that resides under boards/ and soc/
      16             :  *
      17             :  * @note These are all standard soc and board interfaces that are exported from
      18             :  * soc and board specific logic to OS internal logic.  These should never be accessed
      19             :  * directly from application code but may be freely used within the OS.
      20             :  */
      21             : 
      22             : 
      23             : /**
      24             :  * @brief SoC  hook executed at the beginning of the reset vector.
      25             :  *
      26             :  * This hook is implemented by the SoC and can be used to perform any
      27             :  * SoC-specific initialization.
      28             :  */
      29           1 : void soc_reset_hook(void);
      30             : 
      31             : /**
      32             :  * @brief SoC hook executed after the reset vector.
      33             :  *
      34             :  *
      35             :  * This hook is implemented by the SoC and can be used to perform any
      36             :  * SoC-specific initialization.
      37             :  */
      38           1 : void soc_prep_hook(void);
      39             : 
      40             : /*
      41             :  * @brief SoC hook executed before the kernel and devices are initialized.
      42             :  *
      43             :  * This hook is implemented by the SoC and can be used to perform any
      44             :  * SoC-specific initialization.
      45             :  */
      46           0 : void soc_early_init_hook(void);
      47             : 
      48             : /*
      49             :  * @brief SoC hook executed after the kernel and devices are initialized.
      50             :  *
      51             :  * This hook is implemented by the SoC and can be used to perform any
      52             :  * SoC-specific initialization.
      53             :  */
      54           0 : void soc_late_init_hook(void);
      55             : 
      56             : /*
      57             :  * @brief Board hook executed before the kernel starts.
      58             :  *
      59             :  * This is called before the kernel has started. This hook
      60             :  * is implemented by the board and can be used to perform any board-specific
      61             :  * initialization.
      62             :  */
      63           0 : void board_early_init_hook(void);
      64             : 
      65             : /*
      66             :  * @brief Board hook executed after the kernel starts.
      67             : 
      68             :  * This is called after the kernel has started, but before the main function is
      69             :  * called. This hook is implemented by the board and can be used to perform
      70             :  * any board-specific initialization.
      71             :  */
      72           0 : void board_late_init_hook(void);
      73             : 
      74             : #endif