forked from Imagelibrary/threadx
146 lines
6.0 KiB
C
146 lines
6.0 KiB
C
/***************************************************************************
|
|
* Copyright (c) 2024 Microsoft Corporation
|
|
*
|
|
* This program and the accompanying materials are made available under the
|
|
* terms of the MIT License which is available at
|
|
* https://opensource.org/licenses/MIT.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
**************************************************************************/
|
|
|
|
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
/** */
|
|
/** ThreadX Component */
|
|
/** */
|
|
/** Byte Pool */
|
|
/** */
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
|
|
#define TX_SOURCE_CODE
|
|
|
|
|
|
/* Include necessary system files. */
|
|
|
|
#include "tx_api.h"
|
|
#include "tx_thread.h"
|
|
#include "tx_timer.h"
|
|
#include "tx_byte_pool.h"
|
|
|
|
|
|
/**************************************************************************/
|
|
/* */
|
|
/* FUNCTION RELEASE */
|
|
/* */
|
|
/* _txe_byte_pool_delete PORTABLE C */
|
|
/* 6.1 */
|
|
/* AUTHOR */
|
|
/* */
|
|
/* William E. Lamie, Microsoft Corporation */
|
|
/* */
|
|
/* DESCRIPTION */
|
|
/* */
|
|
/* This function checks for errors in the delete byte pool function */
|
|
/* call. */
|
|
/* */
|
|
/* INPUT */
|
|
/* */
|
|
/* pool_ptr Pointer to pool control block */
|
|
/* */
|
|
/* OUTPUT */
|
|
/* */
|
|
/* TX_POOL_ERROR Invalid pool pointer */
|
|
/* TX_CALLER_ERROR Invalid caller of this function */
|
|
/* status Actual completion status */
|
|
/* */
|
|
/* CALLS */
|
|
/* */
|
|
/* _tx_byte_pool_delete Actual byte pool delete function */
|
|
/* */
|
|
/* CALLED BY */
|
|
/* */
|
|
/* Application Code */
|
|
/* */
|
|
/* RELEASE HISTORY */
|
|
/* */
|
|
/* DATE NAME DESCRIPTION */
|
|
/* */
|
|
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
|
|
/* 09-30-2020 Yuxin Zhou Modified comment(s), */
|
|
/* resulting in version 6.1 */
|
|
/* */
|
|
/**************************************************************************/
|
|
UINT _txe_byte_pool_delete(TX_BYTE_POOL *pool_ptr)
|
|
{
|
|
|
|
UINT status;
|
|
#ifndef TX_TIMER_PROCESS_IN_ISR
|
|
TX_THREAD *thread_ptr;
|
|
#endif
|
|
|
|
|
|
#ifndef TX_TIMER_PROCESS_IN_ISR
|
|
|
|
/* Default status to success. */
|
|
status = TX_SUCCESS;
|
|
#endif
|
|
|
|
/* Check for an invalid byte pool pointer. */
|
|
if (pool_ptr == TX_NULL)
|
|
{
|
|
|
|
/* Byte pool pointer is invalid, return appropriate error code. */
|
|
status = TX_POOL_ERROR;
|
|
}
|
|
|
|
/* Now check the pool ID. */
|
|
else if (pool_ptr -> tx_byte_pool_id != TX_BYTE_POOL_ID)
|
|
{
|
|
|
|
/* Byte pool pointer is invalid, return appropriate error code. */
|
|
status = TX_POOL_ERROR;
|
|
}
|
|
|
|
/* Check for interrupt or initialization. */
|
|
else if (TX_THREAD_GET_SYSTEM_STATE() != ((ULONG) 0))
|
|
{
|
|
|
|
/* Invalid caller of this function, return appropriate error code. */
|
|
status = TX_CALLER_ERROR;
|
|
}
|
|
else
|
|
{
|
|
|
|
#ifndef TX_TIMER_PROCESS_IN_ISR
|
|
|
|
/* Pickup thread pointer. */
|
|
TX_THREAD_GET_CURRENT(thread_ptr)
|
|
|
|
/* Check for invalid caller of this function. First check for a calling thread. */
|
|
if (thread_ptr == &_tx_timer_thread)
|
|
{
|
|
|
|
/* Invalid caller of this function, return appropriate error code. */
|
|
status = TX_CALLER_ERROR;
|
|
}
|
|
|
|
/* Determine if everything is okay. */
|
|
if (status == TX_SUCCESS)
|
|
{
|
|
#endif
|
|
|
|
/* Call actual byte pool delete function. */
|
|
status = _tx_byte_pool_delete(pool_ptr);
|
|
|
|
#ifndef TX_TIMER_PROCESS_IN_ISR
|
|
}
|
|
#endif
|
|
}
|
|
|
|
/* Return completion status. */
|
|
return(status);
|
|
}
|
|
|