forked from Imagelibrary/threadx
114 lines
5.8 KiB
C
114 lines
5.8 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 */
|
|
/** */
|
|
/** Queue */
|
|
/** */
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
|
|
#define TX_SOURCE_CODE
|
|
|
|
|
|
/* Include necessary system files. */
|
|
|
|
#include "tx_api.h"
|
|
#include "tx_queue.h"
|
|
|
|
|
|
/**************************************************************************/
|
|
/* */
|
|
/* FUNCTION RELEASE */
|
|
/* */
|
|
/* _txe_queue_info_get PORTABLE C */
|
|
/* 6.1 */
|
|
/* AUTHOR */
|
|
/* */
|
|
/* William E. Lamie, Microsoft Corporation */
|
|
/* */
|
|
/* DESCRIPTION */
|
|
/* */
|
|
/* This function checks for errors in the queue information get */
|
|
/* service. */
|
|
/* */
|
|
/* INPUT */
|
|
/* */
|
|
/* queue_ptr Pointer to queue control block */
|
|
/* name Destination for the queue name */
|
|
/* enqueued Destination for enqueued count */
|
|
/* available_storage Destination for available storage */
|
|
/* first_suspended Destination for pointer of first */
|
|
/* thread suspended on this queue */
|
|
/* suspended_count Destination for suspended count */
|
|
/* next_queue Destination for pointer to next */
|
|
/* queue on the created list */
|
|
/* */
|
|
/* OUTPUT */
|
|
/* */
|
|
/* TX_QUEUE_ERROR Invalid queue pointer */
|
|
/* status Completion status */
|
|
/* */
|
|
/* CALLS */
|
|
/* */
|
|
/* _tx_queue_info_get Actual information get service */
|
|
/* */
|
|
/* 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_queue_info_get(TX_QUEUE *queue_ptr, CHAR **name, ULONG *enqueued, ULONG *available_storage,
|
|
TX_THREAD **first_suspended, ULONG *suspended_count, TX_QUEUE **next_queue)
|
|
{
|
|
|
|
UINT status;
|
|
|
|
|
|
/* Check for an invalid queue pointer. */
|
|
if (queue_ptr == TX_NULL)
|
|
{
|
|
|
|
/* Queue pointer is invalid, return appropriate error code. */
|
|
status = TX_QUEUE_ERROR;
|
|
}
|
|
|
|
/* Now check for a valid queue ID. */
|
|
else if (queue_ptr -> tx_queue_id != TX_QUEUE_ID)
|
|
{
|
|
|
|
/* Queue pointer is invalid, return appropriate error code. */
|
|
status = TX_QUEUE_ERROR;
|
|
}
|
|
else
|
|
{
|
|
|
|
/* Otherwise, call the actual queue information get service. */
|
|
status = _tx_queue_info_get(queue_ptr, name, enqueued, available_storage, first_suspended,
|
|
suspended_count, next_queue);
|
|
}
|
|
|
|
/* Return completion status. */
|
|
return(status);
|
|
}
|
|
|