/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSBSPsPowerPCMPC55XX
 *
 * @brief Low-level configuration.
 */

/*
 * Copyright (C) 2008, 2012 embedded brains GmbH & Co. KG
 *
 * 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 LIBBSP_POWERPC_MPC55XXEVB_MPC55XX_CONFIG_H
#define LIBBSP_POWERPC_MPC55XXEVB_MPC55XX_CONFIG_H

#include <stddef.h>

#include <libcpu/powerpc-utility.h>

#include <bsp/start.h>

#include <mpc55xx/regs.h>
#include <mpc55xx/regs-mmu.h>
#include <mpc55xx/siu.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct {
  uint32_t index : 10;
  uint32_t count : 10;
  uint32_t output : 1;
  union SIU_PCR_tag pcr;
} mpc55xx_siu_pcr_config;

extern BSP_START_DATA_SECTION const mpc55xx_siu_pcr_config
  mpc55xx_start_config_siu_pcr [];

extern BSP_START_DATA_SECTION const size_t
  mpc55xx_start_config_siu_pcr_count [];

extern BSP_START_DATA_SECTION const struct
  MMU_tag mpc55xx_start_config_mmu_early [];

extern BSP_START_DATA_SECTION const size_t
  mpc55xx_start_config_mmu_early_count [];

extern BSP_START_DATA_SECTION const struct
  MMU_tag mpc55xx_start_config_mmu [];

extern BSP_START_DATA_SECTION const size_t
  mpc55xx_start_config_mmu_count [];

#ifdef MPC55XX_HAS_FMPLL
  typedef struct {
    union FMPLL_SYNCR_tag syncr_tmp;
    union FMPLL_SYNCR_tag syncr_final;
  } mpc55xx_clock_config;
#endif

#ifdef MPC55XX_HAS_FMPLL_ENHANCED
  typedef struct {
    union FMPLL_ESYNCR2_tag esyncr2_tmp;
    union FMPLL_ESYNCR2_tag esyncr2_final;
    union FMPLL_ESYNCR1_tag esyncr1_final;
  } mpc55xx_clock_config;
#endif

#ifdef MPC55XX_HAS_MODE_CONTROL
  typedef struct {
    struct {
      PLLD_CR_32B_tag cr;
      PLLD_MR_32B_tag mr;
    } fmpll [2];
    CGM_OC_EN_32B_tag oc_en;
    CGM_OCDS_SC_32B_tag ocds_sc;
    CGM_SC_DC0_3_32B_tag sc_dc0_3;
    CGM_AUXCLK_tag auxclk [5];
  } mpc55xx_clock_config;
#endif

extern BSP_START_DATA_SECTION const mpc55xx_clock_config
  mpc55xx_start_config_clock [];

#ifdef MPC55XX_HAS_EBI
  typedef struct {
    union EBI_MCR_tag ebi_mcr;
    uint32_t siu_eccr_ebdf;
  } mpc55xx_ebi_config;

  extern BSP_START_DATA_SECTION const mpc55xx_ebi_config
    mpc55xx_start_config_ebi [];

  extern BSP_START_DATA_SECTION const size_t
    mpc55xx_start_config_ebi_count [];

  extern BSP_START_DATA_SECTION const struct EBI_CS_tag
    mpc55xx_start_config_ebi_cs [];

  extern BSP_START_DATA_SECTION const size_t
    mpc55xx_start_config_ebi_cs_count [];

  extern BSP_START_DATA_SECTION const struct EBI_CAL_CS_tag
    mpc55xx_start_config_ebi_cal_cs [];

  extern BSP_START_DATA_SECTION const size_t
    mpc55xx_start_config_ebi_cal_cs_count [];
#endif

/**
 * @brief Start prologue.
 *
 * In case the BSP enabled the MPC55XX_ENABLE_START_PROLOGUE option, then this
 * function will be called directly after the Boot Assist Module (BAM) jumped
 * to the start entry defined by the reset configuration.
 *
 * This function executes in the context initialized by the BAM.  There exists
 * no valid stack pointer and the internal RAM has an invalid ECC state.
 *
 * The default implementation does nothing.  The application may provide its
 * own implementation.
 */
void mpc55xx_start_prologue(void);

void mpc55xx_start_early(void);

void mpc55xx_start_flash(void);

void mpc55xx_start_cache(void);

void mpc55xx_start_clock(void);

void mpc55xx_start_watchdog(void);

void mpc55xx_start_mmu_apply_config(const struct MMU_tag *config, size_t count);

uint32_t mpc55xx_get_system_clock(void);

LINKER_SYMBOL(bsp_ram_start)
LINKER_SYMBOL(bsp_ram_end)
LINKER_SYMBOL(bsp_ram_size)

LINKER_SYMBOL(bsp_ram_1_start)
LINKER_SYMBOL(bsp_ram_1_end)
LINKER_SYMBOL(bsp_ram_1_size)

LINKER_SYMBOL(bsp_rom_start)
LINKER_SYMBOL(bsp_rom_end)
LINKER_SYMBOL(bsp_rom_size)

#ifdef MPC55XX_BOOTFLAGS
  extern uint32_t mpc55xx_bootflag_0 [];
#endif

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* LIBBSP_POWERPC_MPC55XXEVB_MPC55XX_CONFIG_H */