alt_cache.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_CACHE_H__
#define __ALT_CACHE_H__

#include "hwlib.h"

#ifdef __cplusplus
extern "C"
{
#endif

#ifndef ALT_CACHE_SUPPORT_NON_FLAT_VIRTUAL_MEMORY
#define ALT_CACHE_SUPPORT_NON_FLAT_VIRTUAL_MEMORY (0)
#endif

#define ALT_CACHE_LINE_SIZE         32

ALT_STATUS_CODE alt_cache_system_enable(void);

ALT_STATUS_CODE alt_cache_system_disable(void);

ALT_STATUS_CODE alt_cache_system_invalidate(void * vaddress, size_t length);

ALT_STATUS_CODE alt_cache_system_clean(void * vaddress, size_t length);

ALT_STATUS_CODE alt_cache_system_purge(void * vaddress, size_t length);

ALT_STATUS_CODE alt_cache_l1_enable_all(void);

ALT_STATUS_CODE alt_cache_l1_disable_all(void);

ALT_STATUS_CODE alt_cache_l1_instruction_enable(void);

ALT_STATUS_CODE alt_cache_l1_instruction_disable(void);

bool alt_cache_l1_instruction_is_enabled(void);

ALT_STATUS_CODE alt_cache_l1_instruction_invalidate(void);

ALT_STATUS_CODE alt_cache_l1_data_enable(void);

ALT_STATUS_CODE alt_cache_l1_data_disable(void);

bool alt_cache_l1_data_is_enabled(void);

ALT_STATUS_CODE alt_cache_l1_data_invalidate(void * vaddress, size_t length);

ALT_STATUS_CODE alt_cache_l1_data_invalidate_all(void);

ALT_STATUS_CODE alt_cache_l1_data_clean(void * vaddress, size_t length);

ALT_STATUS_CODE alt_cache_l1_data_clean_all(void);

ALT_STATUS_CODE alt_cache_l1_data_purge(void * vaddress, size_t length);

ALT_STATUS_CODE alt_cache_l1_data_purge_all(void);

ALT_STATUS_CODE alt_cache_l1_parity_enable(void);

ALT_STATUS_CODE alt_cache_l1_parity_disable(void);

bool alt_cache_l1_parity_is_enabled(void);

ALT_STATUS_CODE alt_cache_l1_branch_enable(void);

ALT_STATUS_CODE alt_cache_l1_branch_disable(void);

bool alt_cache_l1_branch_is_enabled(void);

ALT_STATUS_CODE alt_cache_l1_branch_invalidate(void);

ALT_STATUS_CODE alt_cache_l1_prefetch_enable(void);

ALT_STATUS_CODE alt_cache_l1_prefetch_disable(void);

bool alt_cache_l1_prefetch_is_enabled(void);

ALT_STATUS_CODE alt_cache_l2_init(void);

ALT_STATUS_CODE alt_cache_l2_uninit(void);

ALT_STATUS_CODE alt_cache_l2_prefetch_enable(void);

ALT_STATUS_CODE alt_cache_l2_prefetch_disable(void);

bool alt_cache_l2_prefetch_is_enabled(void);

ALT_STATUS_CODE alt_cache_l2_parity_enable(void);

ALT_STATUS_CODE alt_cache_l2_parity_disable(void);

bool alt_cache_l2_parity_is_enabled(void);

ALT_STATUS_CODE alt_cache_l2_enable(void);

ALT_STATUS_CODE alt_cache_l2_disable(void);

bool alt_cache_l2_is_enabled(void);

ALT_STATUS_CODE alt_cache_l2_sync(void);

ALT_STATUS_CODE alt_cache_l2_invalidate(void * paddress, size_t length);

ALT_STATUS_CODE alt_cache_l2_invalidate_all(void);

ALT_STATUS_CODE alt_cache_l2_clean(void * paddress, size_t length);

ALT_STATUS_CODE alt_cache_l2_clean_all(void);

ALT_STATUS_CODE alt_cache_l2_purge(void * paddress, size_t length);

ALT_STATUS_CODE alt_cache_l2_purge_all(void);

enum ALT_CACHE_L2_INTERRUPT_e
{
    ALT_CACHE_L2_INTERRUPT_DECERR = 1 << 8,

    ALT_CACHE_L2_INTERRUPT_SLVERR = 1 << 7,

    ALT_CACHE_L2_INTERRUPT_ERRRD  = 1 << 6,

    ALT_CACHE_L2_INTERRUPT_ERRRT  = 1 << 5,

    ALT_CACHE_L2_INTERRUPT_ERRWD  = 1 << 4,

    ALT_CACHE_L2_INTERRUPT_ERRWT  = 1 << 3,

    ALT_CACHE_L2_INTERRUPT_PARRD  = 1 << 2,

    ALT_CACHE_L2_INTERRUPT_PARRT  = 1 << 1,

    ALT_CACHE_L2_INTERRUPT_ECNTR  = 1 << 0
};
typedef enum ALT_CACHE_L2_INTERRUPT_e ALT_CACHE_L2_INTERRUPT_t;

ALT_STATUS_CODE alt_cache_l2_int_enable(uint32_t interrupt);

ALT_STATUS_CODE alt_cache_l2_int_disable(uint32_t interrupt);

uint32_t alt_cache_l2_int_status_get(void);

ALT_STATUS_CODE alt_cache_l2_int_status_clear(uint32_t interrupt);

#ifdef __cplusplus
}
#endif

#endif /* __ALT_CACHE_H__ */