alt_address_space.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright 2013 Altera Corporation. All Rights Reserved.
* 
* 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.
* 
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "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 AUTHOR 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 __ALT_ADDRESS_SPACE_H__
#define __ALT_ADDRESS_SPACE_H__

#include <stdbool.h>
#include "hwlib.h"
#include "socal/hps.h"

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

/******************************************************************************/
// ARM Level 2 Cache Controller L2C-310 Register Interface

// Address Filtering Start Register
// The Address Filtering Start Register is a read and write register.
// Bits     Field                       Description
// :-------|:--------------------------|:-----------------------------------------
// [31:20] | address_filtering_start   | Address filtering start address for
//         |                           | bits [31:20] of the filtering address.
// [19:1]  | Reserved                  | SBZ/RAZ
// [0]     | address_filtering_enable  | 0 - address filtering disabled
//         |                           | 1 - address filtering enabled.

// Address Filtering Start Register Address
#define L2_CACHE_ADDR_FILTERING_START_OFST      0xC00
#define L2_CACHE_ADDR_FILTERING_START_ADDR      (ALT_MPUL2_OFST + L2_CACHE_ADDR_FILTERING_START_OFST)
// Address Filtering Start Register - Start Value Mask
#define L2_CACHE_ADDR_FILTERING_START_ADDR_MASK 0xFFF00000
// Address Filtering Start Register - Reset Start Address Value (1 MB)
#define L2_CACHE_ADDR_FILTERING_START_RESET     0x100000
// Address Filtering Start Register - Enable Flag Mask
#define L2_CACHE_ADDR_FILTERING_ENABLE_MASK     0x00000001
// Address Filtering Start Register - Reset Enable Flag Value (Enabled)
#define L2_CACHE_ADDR_FILTERING_ENABLE_RESET    0x1

// Address Filtering End Register
// The Address Filtering End Register is a read and write register.
// Bits     Field                       Description
// :-------|:--------------------------|:-----------------------------------------
// [31:20] | address_filtering_end     | Address filtering end address for bits
//         |                           | [31:20] of the filtering address.
// [19:0]  | Reserved                  | SBZ/RAZ

// Address Filtering End Register Address
#define L2_CACHE_ADDR_FILTERING_END_OFST        0xC04
#define L2_CACHE_ADDR_FILTERING_END_ADDR        (ALT_MPUL2_OFST + L2_CACHE_ADDR_FILTERING_END_OFST)
// Address Filtering End Register - End Value Mask
#define L2_CACHE_ADDR_FILTERING_END_ADDR_MASK   0xFFF00000
// Address Filtering End Register - Reset End Address Value (3 GiB)
#define L2_CACHE_ADDR_FILTERING_END_RESET       0xC0000000

#ifndef __ASSEMBLY__

/******************************************************************************/
/******************************************************************************/
/******************************************************************************/
typedef enum ALT_ADDR_SPACE_MPU_ATTR_e
{
    ALT_ADDR_SPACE_MPU_ZERO_AT_BOOTROM,     
    ALT_ADDR_SPACE_MPU_ZERO_AT_OCRAM        
} ALT_ADDR_SPACE_MPU_ATTR_t;

/******************************************************************************/
typedef enum ALT_ADDR_SPACE_NONMPU_ATTR_e
{
    ALT_ADDR_SPACE_NONMPU_ZERO_AT_SDRAM,    
    ALT_ADDR_SPACE_NONMPU_ZERO_AT_OCRAM     
} ALT_ADDR_SPACE_NONMPU_ATTR_t;

/******************************************************************************/
typedef enum ALT_ADDR_SPACE_H2F_BRIDGE_ATTR_e
{
    ALT_ADDR_SPACE_H2F_INACCESSIBLE,        
    ALT_ADDR_SPACE_H2F_ACCESSIBLE           
} ALT_ADDR_SPACE_H2F_BRIDGE_ATTR_t;

/******************************************************************************/
typedef enum ALT_ADDR_SPACE_LWH2F_BRIDGE_ATTR_e
{
    ALT_ADDR_SPACE_LWH2F_INACCESSIBLE,      
    ALT_ADDR_SPACE_LWH2F_ACCESSIBLE         
} ALT_ADDR_SPACE_LWH2F_BRIDGE_ATTR_t;

/******************************************************************************/
ALT_STATUS_CODE alt_addr_space_remap(ALT_ADDR_SPACE_MPU_ATTR_t mpu_attr,
                                     ALT_ADDR_SPACE_NONMPU_ATTR_t nonmpu_attr,
                                     ALT_ADDR_SPACE_H2F_BRIDGE_ATTR_t h2f_attr,
                                     ALT_ADDR_SPACE_LWH2F_BRIDGE_ATTR_t lwh2f_attr);

/******************************************************************************/
ALT_STATUS_CODE alt_mpu_addr_space_remap_0_to_sdram(void);

/******************************************************************************/
/******************************************************************************/
ALT_STATUS_CODE alt_l2_addr_filter_cfg_get(uint32_t* addr_filt_start,
                                           uint32_t* addr_filt_end);

/******************************************************************************/
ALT_STATUS_CODE alt_l2_addr_filter_cfg_set(uint32_t addr_filt_start,
                                           uint32_t addr_filt_end);

/******************************************************************************/
/******************************************************************************/
#define ALT_ACP_ID_MAP_MASTER_ID_MASK           0xfff

#define ALT_ACP_ID_MAP_MASTER_ID_L2M0(var)      (0x00000002 | (0x000007f8 & (var)))

#define ALT_ACP_ID_MAP_MASTER_ID_DMA(var)       (0x00000001 | (0x00000078 & (var)))

#define ALT_ACP_ID_MAP_MASTER_ID_EMAC0(var)     (0x00000801 | (0x00000878 & (var)))

#define ALT_ACP_ID_MAP_MASTER_ID_EMAC1(var)     (0x00000802 | (0x00000878 & (var)))

#define ALT_ACP_ID_MAP_MASTER_ID_USB0           0x00000803

#define ALT_ACP_ID_MAP_MASTER_ID_USB1           0x00000806

#define ALT_ACP_ID_MAP_MASTER_ID_NAND(var)      (0x00000804 | (0x00000ff8 & (var)))

#define ALT_ACP_ID_MAP_MASTER_ID_TMC            0x00000800

#define ALT_ACP_ID_MAP_MASTER_ID_DAP            0x00000004

#define ALT_ACP_ID_MAP_MASTER_ID_SDMMC          0x00000805

#define ALT_ACP_ID_MAP_MASTER_ID_F2H(var)       (0x00000000 | (0x000007f8 & (var)))

/******************************************************************************/
typedef enum ALT_ACP_ID_OUTPUT_ID_e
{
    ALT_ACP_ID_OUT_FIXED_ID_2 = 2,  
    ALT_ACP_ID_OUT_DYNAM_ID_3 = 3,  
    ALT_ACP_ID_OUT_DYNAM_ID_4 = 4,  
    ALT_ACP_ID_OUT_DYNAM_ID_5 = 5,  
    ALT_ACP_ID_OUT_DYNAM_ID_6 = 6,  
    ALT_ACP_ID_OUT_DYNAM_ID_7 = 7   
} ALT_ACP_ID_OUTPUT_ID_t;

typedef enum ALT_ACP_ID_MAP_PAGE_e
{
    ALT_ACP_ID_MAP_PAGE_0 = 0,  
    ALT_ACP_ID_MAP_PAGE_1 = 1,  
    ALT_ACP_ID_MAP_PAGE_2 = 2,  
    ALT_ACP_ID_MAP_PAGE_3 = 3   
} ALT_ACP_ID_MAP_PAGE_t;

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_fixed_read_set(const uint32_t input_id,
                                              const uint32_t output_id,
                                              const ALT_ACP_ID_MAP_PAGE_t page,
                                              const uint32_t aruser);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_fixed_write_set(const uint32_t input_id,
                                               const uint32_t output_id,
                                               const ALT_ACP_ID_MAP_PAGE_t page,
                                               const uint32_t awuser);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_dynamic_read_set(const uint32_t output_id);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_dynamic_write_set(const uint32_t output_id);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_dynamic_read_options_set(const ALT_ACP_ID_MAP_PAGE_t page,
                                                        const uint32_t aruser);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_dynamic_write_options_set(const ALT_ACP_ID_MAP_PAGE_t page,
                                                         const uint32_t awuser);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_read_options_get(const uint32_t output_id,
                                                bool* fixed,
                                                uint32_t* input_id,
                                                ALT_ACP_ID_MAP_PAGE_t* page,
                                                uint32_t* aruser);

/******************************************************************************/
ALT_STATUS_CODE alt_acp_id_map_write_options_get(const uint32_t output_id,
                                                 bool* fixed,
                                                 uint32_t* input_id,
                                                 ALT_ACP_ID_MAP_PAGE_t* page,
                                                 uint32_t* awuser);

#endif  /* __ASSEMBLY__ */

#ifdef __cplusplus
}
#endif  /* __cplusplus */
#endif  /* __ALT_ADDRESS_SPACE_H__ */