/*
 * Arm SCP/MCP Software
 * Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef MOD_CMN_BOOKER_H
#define MOD_CMN_BOOKER_H

#include <fwk_id.h>

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

/*!
 * \addtogroup GroupModules Modules
 * \{
 */

/*!
 * \defgroup GroupModuleCMN_BOOKER CMN_BOOKER
 *
 * \brief Arm Coherent Mesh Network (CMN) BOOKER module
 *
 * \details This module adds support for the CMN_BOOKER interconnect
 * \{
 */

/*!
 * \brief Module API indices
 */
enum mod_cmn_booker_api_idx {
    /*! Index of the PPU_V1 power state observer API */
    MOD_CMN_BOOKER_API_IDX_PPU_OBSERVER,

    /*! Number of APIs */
    MOD_CMN_BOOKER_API_COUNT
};

/*!
 * \brief Memory region configuration type
 */
enum mod_cmn_booker_mem_region_type {
    /*! Input/Output region (serviced by dedicated HN-I and HN-D nodes) */
    MOD_CMN_BOOKER_MEM_REGION_TYPE_IO,

    /*!
     * Region backed by the system cache (serviced by all HN-F nodes in the
     * system)
     */
    MOD_CMN_BOOKER_MEM_REGION_TYPE_SYSCACHE,

    /*!
     * Sub region of the system cache for non-hashed access (serviced by
     * dedicated SN-F nodes).
     */
    MOD_CMN_BOOKER_REGION_TYPE_SYSCACHE_SUB,
};

/*!
 * \brief Memory region map descriptor
 */
struct mod_cmn_booker_mem_region_map {
    /*! Base address */
    uint64_t base;

    /*! Region size in bytes */
    uint64_t size;

    /*! Region configuration type */
    enum mod_cmn_booker_mem_region_type type;

    /*!
     * \brief Target node identifier
     *
     * \note Not used for ::mod_cmn_booker_mem_region_type.
     *      MOD_CMN_BOOKER_MEM_REGION_TYPE_SYSCACHE
     *      memory regions as it uses the pool of HN-F nodes available in the
     *      system
     */
    unsigned int node_id;
};

/*!
 * \brief CMN_BOOKER configuration data
 */
struct mod_cmn_booker_config {
    /*! Peripheral base address. */
    uintptr_t base;

    /*! Size along x-axis of the interconnect mesh */
    unsigned int mesh_size_x;

    /*! Size along y-axis of the interconnect mesh */
    unsigned int mesh_size_y;

    /*! Default HN-D node identifier containing the global configuration */
    unsigned int hnd_node_id;

    /*!
     * \brief Table of SN-Fs used as targets for the HN-F nodes
     *
     * \details Each entry of this table corresponds to a HN-F node in the
     *      system. The HN-F's logical identifiers are used as indices in this
     *      table
     */
    const unsigned int *snf_table;

    /*! Number of entries in the ::mod_cmn_booker_config::snf_table */
    size_t snf_count;

    /*! Table of region memory map entries */
    const struct mod_cmn_booker_mem_region_map *mmap_table;

    /*! Number of entries in the ::mod_cmn_booker_config::mmap_table */
    size_t mmap_count;

    /*! Identifier of the clock that this device depends on */
    fwk_id_t clock_id;

    /*!
     * \brief HN-F with CAL support flag
     * \details When set to true, enables HN-F with CAL support. This flag will
     *      be used only if HN-F is found to be connected to CAL (When connected
     *      to a CAL port, node id of HN-F will be a odd number).
     */
    bool hnf_cal_mode;

    /*! \
     * \brief Number of device ports per XP
     * \details The calculation for CFGM base address depends on the number of
     *      ports per cross point
     */
    unsigned int ports_per_xp;
};

/*!
 * \}
 */

/*!
 * \}
 */

#endif /* MOD_CMN_BOOKER_H */