diff options
Diffstat (limited to 'drivers/staging/media/atomisp/pci/atomisp2/css2400/hive_isp_css_include/memory_access/memory_access.h')
| -rw-r--r-- | drivers/staging/media/atomisp/pci/atomisp2/css2400/hive_isp_css_include/memory_access/memory_access.h | 317 |
1 files changed, 317 insertions, 0 deletions
diff --git a/drivers/staging/media/atomisp/pci/atomisp2/css2400/hive_isp_css_include/memory_access/memory_access.h b/drivers/staging/media/atomisp/pci/atomisp2/css2400/hive_isp_css_include/memory_access/memory_access.h new file mode 100644 index 000000000000..9d105ecf5d7f --- /dev/null +++ b/drivers/staging/media/atomisp/pci/atomisp2/css2400/hive_isp_css_include/memory_access/memory_access.h @@ -0,0 +1,317 @@ +/* + * Support for Intel Camera Imaging ISP subsystem. + * Copyright (c) 2015, Intel Corporation. + * + * This program is free software; you can redistribute it and/or modify it + * under the terms and conditions of the GNU General Public License, + * version 2, as published by the Free Software Foundation. + * + * This program is distributed in the hope it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + */ + +#ifndef __MEMORY_ACCESS_H_INCLUDED__ +#define __MEMORY_ACCESS_H_INCLUDED__ + +/*! + * \brief + * Define the public interface for virtual memory + * access functions. Access types are limited to + * those defined in <stdint.h> + * + * The address representation is private to the system + * and represented as "hrt_vaddress" rather than a + * pointer, as the memory allocation cannot be accessed + * by dereferencing but reaquires load and store access + * functions + * + * The page table selection or virtual memory context; + * The page table base index; Is implicit. This page + * table base index must be set by the implementation + * of the access function + * + * "store" is a transfer to the system + * "load" is a transfer from the system + * + * Allocation properties can be specified by setting + * attributes (see below) in case of multiple physical + * memories the memory ID is encoded on the attribute + * + * Allocations in the same physical memory, but in a + * different (set of) page tables can be shared through + * a page table information mapping function + */ + +#include <type_support.h> +#include "platform_support.h" /* for __func__ */ + +/* + * User provided file that defines the (sub)system address types: + * - hrt_vaddress a type that can hold the (sub)system virtual address range + */ +#include "system_types.h" + +/* + * The MMU base address is a physical address, thus the same type is used + * as for the device base address + */ +#include "device_access.h" + +/*! + * \brief + * Bit masks for specialised allocation functions + * the default is "uncached", "not contiguous", + * "not page aligned" and "not cleared" + * + * Forcing alignment (usually) returns a pointer + * at an alignment boundary that is offset from + * the allocated pointer. Without storing this + * pointer/offset, we cannot free it. The memory + * manager is responsible for the bookkeeping, e.g. + * the allocation function creates a sentinel + * within the allocation referencable from the + * returned pointer/address. + */ +#define MMGR_ATTRIBUTE_MASK 0x000f +#define MMGR_ATTRIBUTE_CACHED 0x0001 +#define MMGR_ATTRIBUTE_CONTIGUOUS 0x0002 +#define MMGR_ATTRIBUTE_PAGEALIGN 0x0004 +#define MMGR_ATTRIBUTE_CLEARED 0x0008 +#define MMGR_ATTRIBUTE_UNUSED 0xfff0 + +/* #define MMGR_ATTRIBUTE_DEFAULT (MMGR_ATTRIBUTE_CACHED) */ +#define MMGR_ATTRIBUTE_DEFAULT 0 + +extern const hrt_vaddress mmgr_NULL; +extern const hrt_vaddress mmgr_EXCEPTION; + +/*! Set the (sub)system virtual memory page table base address + + \param base_addr[in] The address where page table 0 is located + + \Note: The base_addr is an absolute system address, thus it is not + relative to the DDR base address + + \return none, + */ +extern void mmgr_set_base_address( + const sys_address base_addr); + +/*! Get the (sub)system virtual memory page table base address + + \return base_address, + */ +/* unused */ +extern sys_address mmgr_get_base_address(void); + + +/*! Set the (sub)system virtual memory page table base index + + \param base_addr[in] The index where page table 0 is located + + \Note: The base_index is the MSB section of an absolute system address, + the in-page address bits are discared. The base address is not + relative to the DDR base address + + \return none, + */ +/* unused */ +extern void mmgr_set_base_index( + const hrt_data base_index); + +/*! Get the (sub)system virtual memory page table base index + + \return base_address, + */ +/* unused */ +extern hrt_data mmgr_get_base_index(void); + +/*! Return the address of an allocation in memory + + \param size[in] Size in bytes of the allocation + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return vaddress + */ +#define mmgr_malloc(__size) mmgr_malloc_ex(__size, __func__, __LINE__) +extern hrt_vaddress mmgr_malloc_ex( + const size_t size, + const char *caller_func, + int caller_line); + +/*! Return the address of a zero initialised allocation in memory + + \param N[in] Horizontal dimension of array + \param size[in] Vertical dimension of array Total size is N*size + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return vaddress + */ +#define mmgr_calloc(__N, __size) mmgr_calloc_ex(__N, __size, __func__, __LINE__) +extern hrt_vaddress mmgr_calloc_ex( + const size_t N, + const size_t size, + const char *caller_func, + int caller_line); + +/*! Return the address of a reallocated allocation in memory + + \param vaddr[in] Address of an allocation + \param size[in] Size in bytes of the allocation + + \Note + All limitations and particularities of the C stdlib + realloc function apply + + \return vaddress + */ +/* unused */ +extern hrt_vaddress mmgr_realloc( + hrt_vaddress vaddr, + const size_t size); + +/*! Free the memory allocation identified by the address + + \param vaddr[in] Address of the allocation + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return vaddress + */ +#define mmgr_free(__vaddr) mmgr_free_ex(__vaddr, __func__, __LINE__) +extern void mmgr_free_ex( + hrt_vaddress vaddr, + const char *caller_func, + int caller_line); + +/*! Return the address of an allocation in memory + + \param size[in] Size in bytes of the allocation + \param attribute[in] Bit vector specifying the properties + of the allocation including zero initialisation + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return vaddress + */ +#define mmgr_alloc_attr(__size, __attribute) mmgr_alloc_attr_ex(__size, __attribute, __func__, __LINE__) +extern hrt_vaddress mmgr_alloc_attr_ex( + const size_t size, + const uint16_t attribute, + const char *caller_func, + int caller_line); + +/*! Return the address of a reallocated allocation in memory + + \param vaddr[in] Address of an allocation + \param size[in] Size in bytes of the allocation + \param attribute[in] Bit vector specifying the properties + of the allocation +#endif + + \Note + All limitations and particularities of the C stdlib + realloc function apply + + \return vaddress + */ +/* unused */ +extern hrt_vaddress mmgr_realloc_attr( + hrt_vaddress vaddr, + const size_t size, + const uint16_t attribute); + +/*! Return the address of a mapped existing allocation in memory + + \param ptr[in] Pointer to an allocation in a different + virtual memory page table, but the same + physical memory + \param size[in] Size of the memory of the pointer + \param attribute[in] Bit vector specifying the properties + of the allocation + \param context Pointer of a context provided by + client/driver for additonal parameters + needed by the implementation + \Note + This interface is tentative, limited to the desired function + the actual interface may require furhter parameters + + \return vaddress + */ +extern hrt_vaddress mmgr_mmap( + const void *ptr, + const size_t size, + uint16_t attribute, + void *context); + +/*! Zero initialise an allocation in memory + + \param vaddr[in] Address of an allocation + \param size[in] Size in bytes of the area to be cleared + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return none + */ +#define mmgr_clear(__vaddr, __size) mmgr_clear_ex(__vaddr, __size, __func__, __LINE__) +extern void mmgr_clear_ex( + hrt_vaddress vaddr, + const size_t size, + const char *caller_func, + int caller_line); + +/*! Set an allocation in memory to a value + + \param vaddr[in] Address of an allocation + \param data[in] Value to set + \param size[in] Size in bytes of the area to be set + + \return none + */ +/* unused */ +extern void mmgr_set( + hrt_vaddress vaddr, + const uint8_t data, + const size_t size); + +/*! Read an array of bytes from a virtual memory address + + \param vaddr[in] Address of an allocation + \param data[out] pointer to the destination array + \param size[in] number of bytes to read + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return none + */ +#define mmgr_load(__vaddr, __data, __size) mmgr_load_ex(__vaddr, __data, __size, __func__, __LINE__) +extern void mmgr_load_ex( + const hrt_vaddress vaddr, + void *data, + const size_t size, + const char *caller_func, + int caller_line); + +/*! Write an array of bytes to device registers or memory in the device + + \param vaddr[in] Address of an allocation + \param data[in] pointer to the source array + \param size[in] number of bytes to write + \param caller_func[in] Caller function name + \param caller_line[in] Caller function line number + + \return none + */ +#define mmgr_store(__vaddr, __data, __size) mmgr_store_ex(__vaddr, __data, __size, __func__, __LINE__) +extern void mmgr_store_ex( + const hrt_vaddress vaddr, + const void *data, + const size_t size, + const char *caller_func, + int caller_line); + +#endif /* __MEMORY_ACCESS_H_INCLUDED__ */ |