mcu/service/mertos/include/mer_service_fixmem.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2018
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
*
* Filename:
* ---------
*   mer_service_fixmem.h
*
* Project:
* --------
*   MERTOS
*
* Description:
* ------------
*   Declare data structures and functions for fixed block size memory.
*
* Author:
* -------
 * -------
*
*****************************************************************************/

#ifndef _MER_SERVICE_FIXMEM_H_
#define _MER_SERVICE_FIXMEM_H_

#include "mer_service_types.h"

#define mer_service_fixmem_GET(type, fixmemsize) g_fixmem_pool_##type##_##fixmemsize

// Control block of a fixmem pool
// Now, it can manage 1024 blocks at most.
typedef struct
{
    mer_bool     pool_is_allocated;
    mer_mem_ptr  pmem;
    mer_uint32   blksize;
    mer_uint32   blknum;
    mer_uint8    max_group;
    mer_uint32   group_mgr; 
    mer_uint32   groups[32];
} mer_service_fixmem_pool_cb;
typedef mer_service_fixmem_pool_cb mer_service_fixmem_pool, *mer_service_fixmem_pool_id;

// Allocate a memory block of blksize
MER_STATUS mer_service_fixmem_alloc_blk
(
    mer_service_fixmem_pool_id  pmid,
    mer_mem_ptr                 *pptr
);

// Allocate a memory block of blksize with multi-threading active
MER_STATUS mer_service_fixmem_alloc_blk_in_mt
(
    mer_service_fixmem_pool_id  pmid,
    mer_mem_ptr                 *pptr
);

// Allocate a memory block of blksize with interrupt disabled
MER_STATUS mer_service_fixmem_alloc_blk_with_di
(
    mer_service_fixmem_pool_id  pmid,
    mer_mem_ptr                 *pptr
);

// Free a memory block of blksize
MER_STATUS mer_service_fixmem_free_blk
(
    mer_service_fixmem_pool_id  fixmemid,
    mer_mem_ptr                 ptr
);

// Free a memory block of blksize with multi-threading active
MER_STATUS mer_service_fixmem_free_blk_in_mt
(
    mer_service_fixmem_pool_id  fixmemid,
    mer_mem_ptr                 ptr
);

// Free a memory block of blksize with interrupt disabled
MER_STATUS mer_service_fixmem_free_blk_with_di
(
    mer_service_fixmem_pool_id  fixmemid,
    mer_mem_ptr                 ptr
);

#endif /* _MER_SERVICE_FIXMEM_H_ */