/* --------------------------------------------------------------------------
 * Copyright (c) 2013-2019 Arm Limited. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the License); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 *      Name:    freertos_mpool.h
 *      Purpose: CMSIS RTOS2 wrapper for FreeRTOS
 *
 *---------------------------------------------------------------------------*/

#ifndef FREERTOS_MPOOL_H_
#define FREERTOS_MPOOL_H_

#include <stdint.h>
#include "FreeRTOS.h"
#include "semphr.h"

/* Memory Pool implementation definitions */
#define MPOOL_STATUS              0x5EED0000U
#define MPOOL_SEM                 StaticSemaphore_t

/* Memory Block header */
typedef struct {
  void *next;                   /* Pointer to next block  */
} MPOOL_BLOCK;

/* Memory Pool control block */
typedef struct MemPoolDef_t {
  MPOOL_BLOCK *head;            /* Pointer to head block  */
  MPOOL_SEM    sem;             /* Pool semaphore object  */
  uint8_t     *mem_arr;         /* Pool memory array      */
  uint32_t     mem_sz;          /* Pool memory array size */
  const
  char        *name;            /* Pointer to name string */
  uint32_t     bl_sz;           /* Size of a single block */
  uint32_t     bl_cnt;          /* Number of blocks       */
  uint32_t     n;               /* Block allocation index */
  volatile
  uint32_t     status;          /* Object status flags    */
} MemPool_t;

/* No need to hide static object type, just align to coding style */
#define StaticMemPool_t         MemPool_t

/* Define memory pool control block size */
#define MEMPOOL_CB_SIZE         (sizeof(StaticMemPool_t))

/* Define size of the byte array required to create count of blocks of given size */
#define MEMPOOL_ARR_SIZE(bl_count, bl_size) (((((bl_size) + (4 - 1)) / 4) * 4)*(bl_count))

#endif /* FREERTOS_MPOOL_H_ */