0abe07a0cd
This enable defining memory maps in source code in addition to defining in MDEF files. This introduces the macro DEFINE_MEM_MAP(mem_map_name, ...). The memory maps created this way are the same, in functionality, as those defined in MDEF files. They can be manipulated by the standard microkernel memory map APIs. Define the memory map using: DEFINE_MEM_MAP(mem_map1, blocks, block_size); and "mem_map1" can be used, for example: task_mem_map_alloc(mem_map1, ...); or, task_mem_map_free(mem_map1, ...); etc. To use the memory map defined in another source file, simply add: extern const kmemory_map_t mem_map1; to the desired C or header file. Change-Id: I9c551b90f9d0a95f961fd8ec1c5278c2ea44312d Signed-off-by: Daniel Leung <daniel.leung@intel.com>
149 lines
4.7 KiB
C
149 lines
4.7 KiB
C
/*
|
|
* Copyright (c) 1997-2012, 2014 Wind River Systems, Inc.
|
|
*
|
|
* 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) Neither the name of Wind River Systems nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software without
|
|
* specific prior written permission.
|
|
*
|
|
* 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 HOLDER 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.
|
|
*/
|
|
|
|
/* @file
|
|
* @brief Memory map kernel services.
|
|
*/
|
|
|
|
#ifndef _MEMORY_MAP_H
|
|
#define _MEMORY_MAP_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <sections.h>
|
|
|
|
extern int _task_mem_map_alloc(kmemory_map_t mmap, void **mptr, int32_t time);
|
|
extern void _task_mem_map_free(kmemory_map_t mmap, void **mptr);
|
|
|
|
/**
|
|
* @brief Read the number of used blocks in a memory map
|
|
*
|
|
* This routine returns the number of blocks in use for the memory map.
|
|
*
|
|
* @param map Memory map.
|
|
*
|
|
* @return number of used blocks
|
|
*/
|
|
extern int task_mem_map_used_get(kmemory_map_t map);
|
|
|
|
/**
|
|
* @brief Return memory map block request
|
|
*
|
|
* This routine returns a block to the specified memory map. If a higher
|
|
* priority task is waiting for a block from the same map a task switch
|
|
* takes place.
|
|
*
|
|
* @param m Memory map.
|
|
* @param p Block of memory to return.
|
|
*
|
|
* @return N/A
|
|
*/
|
|
#define task_mem_map_free(m, p) _task_mem_map_free(m, p)
|
|
|
|
/**
|
|
* @brief Allocate memory map block request
|
|
*
|
|
* This routine is used to request a block of memory from the memory map.
|
|
*
|
|
* @param m Memory map from which to request block.
|
|
* @param p Pointer to requested block of memory.
|
|
*
|
|
* @return RC_OK on success or RC_FAIL on error.
|
|
*/
|
|
#define task_mem_map_alloc(m, p) _task_mem_map_alloc(m, p, TICKS_NONE)
|
|
|
|
/**
|
|
* @brief Allocate memory map block request
|
|
*
|
|
* This routine is used to request a block of memory from the memory map.
|
|
* The task will wait if the memory block is not available.
|
|
*
|
|
* @param m Memory map from which to request block.
|
|
* @param p Pointer to requested block of memory.
|
|
*
|
|
* @return RC_OK on success or RC_FAIL on error.
|
|
*/
|
|
#define task_mem_map_alloc_wait(m, p) _task_mem_map_alloc(m, p, TICKS_UNLIMITED)
|
|
|
|
#ifdef CONFIG_SYS_CLOCK_EXISTS
|
|
|
|
/**
|
|
* @brief Allocate memory map block request with timeout
|
|
*
|
|
* This routine is used to request a block of memory from the memory map.
|
|
* The task will wait if the memory block is not available until the timeout
|
|
* expire or the memory is available.
|
|
*
|
|
* @param m Memory map from which to request block.
|
|
* @param p Pointer to requested block of memory.
|
|
* @param t Maximum number of ticks for which to wait.
|
|
*
|
|
* @return RC_OK, RC_FAIL, RC_TIME on success, error, timeout respectively
|
|
*/
|
|
#define task_mem_map_alloc_wait_timeout(m, p, t) _task_mem_map_alloc(m, p, t)
|
|
#endif
|
|
|
|
/**
|
|
* @brief Initialize a memory map struct.
|
|
*
|
|
* @param blocks Number of blocks.
|
|
* @param block_size Block Size (in bytes).
|
|
*/
|
|
#define __K_MEM_MAP_INITIALIZER(blocks, block_size, buffer) \
|
|
{ \
|
|
.Nelms = blocks, \
|
|
.Esize = block_size, \
|
|
.Base = buffer, \
|
|
}
|
|
|
|
/**
|
|
* @brief Define a private microkernel memory map.
|
|
*
|
|
* @param name Name of the memory map.
|
|
* @param blocks Number of blocks.
|
|
* @param block_size Size of each blocks (in bytes).
|
|
*/
|
|
#define DEFINE_MEM_MAP(name, blocks, block_size) \
|
|
char __noinit __mem_map_buffer_##name[(blocks * block_size)]; \
|
|
struct _k_mem_map_struct _k_mem_map_obj_##name = \
|
|
__K_MEM_MAP_INITIALIZER(blocks, block_size, \
|
|
__mem_map_buffer_##name); \
|
|
const kmemory_map_t name \
|
|
__section(_k_mem_map_ptr, private, mem_map) = \
|
|
(kmemory_map_t)&_k_mem_map_obj_##name;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _MEMORY_MAP_H */
|