Files
threadx/common_modules/module_lib/src/txm_byte_pool_create.c
2022-01-29 00:24:03 +00:00

92 lines
5.8 KiB
C

/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** ThreadX Component */
/** */
/** Module */
/** */
/**************************************************************************/
/**************************************************************************/
#define TXM_MODULE
#include "txm_module.h"
#ifndef TXM_BYTE_POOL_CREATE_CALL_NOT_USED
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _txe_byte_pool_create PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Scott Larson, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks for errors in the create byte pool memory */
/* function. */
/* */
/* INPUT */
/* */
/* pool_ptr Pointer to pool control block */
/* name_ptr Pointer to byte pool name */
/* pool_start Address of beginning of pool area */
/* pool_size Number of bytes in the byte pool */
/* pool_control_block_size Size of byte pool control block */
/* */
/* OUTPUT */
/* */
/* TX_POOL_ERROR Invalid byte pool pointer */
/* TX_PTR_ERROR Invalid pool starting address */
/* TX_SIZE_ERROR Invalid pool size */
/* TX_CALLER_ERROR Invalid caller of this function */
/* status Actual completion status */
/* */
/* CALLS */
/* */
/* _txm_module_kernel_call_dispatcher */
/* */
/* CALLED BY */
/* */
/* Module application code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 09-30-2020 Scott Larson Initial Version 6.1 */
/* 01-31-2022 Scott Larson Modified comments and added */
/* CALL_NOT_USED option, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
UINT _txe_byte_pool_create(TX_BYTE_POOL *pool_ptr, CHAR *name_ptr, VOID *pool_start, ULONG pool_size, UINT pool_control_block_size)
{
UINT return_value;
ALIGN_TYPE extra_parameters[3];
extra_parameters[0] = (ALIGN_TYPE) pool_start;
extra_parameters[1] = (ALIGN_TYPE) pool_size;
extra_parameters[2] = (ALIGN_TYPE) pool_control_block_size;
/* Call module manager dispatcher. */
return_value = (UINT) (_txm_module_kernel_call_dispatcher)(TXM_BYTE_POOL_CREATE_CALL, (ALIGN_TYPE) pool_ptr, (ALIGN_TYPE) name_ptr, (ALIGN_TYPE) extra_parameters);
/* Return value to the caller. */
return(return_value);
}
#endif