sys_memory_manager.h 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. /**
  2. * Copyright (c) 2016 - 2020 Nordic Semiconductor ASA and Luxoft Global Operations Gmbh.
  3. *
  4. * All Rights Reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. *
  10. * 1. Redistributions of source code must retain the above copyright notice, this
  11. * list of conditions and the following disclaimer.
  12. *
  13. * 2. Redistributions in binary form, except as embedded into a Nordic
  14. * Semiconductor ASA integrated circuit in a product or a software update for
  15. * such product, must reproduce the above copyright notice, this list of
  16. * conditions and the following disclaimer in the documentation and/or other
  17. * materials provided with the distribution.
  18. *
  19. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  20. * contributors may be used to endorse or promote products derived from this
  21. * software without specific prior written permission.
  22. *
  23. * 4. This software, with or without modification, must only be used with a
  24. * Nordic Semiconductor ASA integrated circuit.
  25. *
  26. * 5. Any software provided in binary form under this license must not be reverse
  27. * engineered, decompiled, modified and/or disassembled.
  28. *
  29. *
  30. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  31. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  34. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  36. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  39. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40. *
  41. */
  42. #ifndef SYS_MEMORY_MANAGER_H_INCLUDED
  43. #define SYS_MEMORY_MANAGER_H_INCLUDED
  44. #include <stddef.h>
  45. #include <stdint.h>
  46. /** @file
  47. * This file contains declarations of the Memory manager API.
  48. *
  49. * @defgroup sys_memory_manager Memory Manager API
  50. * @ingroup sys_15_4
  51. * @{
  52. * @brief Module to declare Memory Manager API.
  53. * @details The Memory Manager module implements the standard API for allocating/freeing memory chunks. The module must
  54. * be initialized by sys_mm_init() before a call to any alloc/free routines. The memory can be allocated by a
  55. * call to sys_mm_alloc() and freed by a call to sys_mm_free(). Minimal chunk of memory to allocate is one byte,
  56. * however the sys_mm_alloc() routine will allocate the number of bytes aligned to the length of the
  57. * machine word (e.g. 4 bytes for 32-bit architectures). The module is implemented using the doubly linked
  58. * lists API.
  59. */
  60. /**@brief Function for initializing the memory manager.
  61. * @details Initialize the memory manager pool of the 'size' bytes length at 'p_start' address.
  62. *
  63. * @param p_start Pool start address.
  64. * @param size Size of the pool in bytes.
  65. */
  66. void sys_mm_init(void * p_start, size_t size);
  67. /**@brief Function for allocating memory in the pool.
  68. * @details Search and allocate free memory resources.
  69. *
  70. * @param[in] size Size of the requested memory.
  71. *
  72. * @retval Pointer to allocated memory,
  73. * NULL in case of error.
  74. */
  75. void * sys_mm_alloc(size_t size);
  76. /**@brief Function for freeing the allocated memory.
  77. *
  78. * @param[in] p_addr Pointer to the memory to free.
  79. *
  80. */
  81. void sys_mm_free(void * p_addr);
  82. /** @} */
  83. #endif // SYS_MEMORY_MANAGER_H_INCLUDED