fc-selenite: src/nucleus/quce.c annotate

annotate src/nucleus/quce.c @ 86:425ab6d987f3

src/libsys: pieced together from Citrine

author	Mychaela Falconia <falcon@freecalypso.org>
date	Fri, 20 Jul 2018 20:36:19 +0000
parents	0f80e1e4dce4
children

rev	line source
7 0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3 /* Copyright Mentor Graphics Corporation 2002 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 /* All Rights Reserved. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 /* THIS WORK CONTAINS TRADE SECRET AND PROPRIETARY INFORMATION WHICH IS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7 /* THE PROPERTY OF MENTOR GRAPHICS CORPORATION OR ITS LICENSORS AND IS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 /* SUBJECT TO LICENSE TERMS. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14 /* FILE NAME VERSION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 /* quce.c Nucleus PLUS 1.14 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 /* COMPONENT */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20 /* QU - Queue Management */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 /* DESCRIPTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24 /* This file contains error checking routines for core functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25 /* of the Queue component. This permits easy removal of error */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26 /* checking logic when it is not needed. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 /* DATA STRUCTURES */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 /* None */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32 /* FUNCTIONS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34 /* QUCE_Create_Queue Create a queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 /* QUCE_Delete_Queue Delete a queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36 /* QUCE_Send_To_Queue Send a queue message */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 /* QUCE_Receive_From_Queue Receive a queue message */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39 /* DEPENDENCIES */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41 /* cs_extr.h Common Service functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42 /* tc_extr.h Thread Control functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 /* qu_extr.h Queue functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45 /* HISTORY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 /* DATE REMARKS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 /* 03-01-1993 Created initial version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 /* 04-19-1993 Verified version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 /* 03-01-1994 Split original error checking */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 /* file and changed function */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53 /* interfaces, resulting in */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 /* version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 /* 03-18-1994 Verified version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 /* 04-17-1996 updated to version 1.2 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58 /* 10-28-1997 Modified QUCE_Receive_From_Queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59 /* to correct SPR142. This */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 /* created version 1.2a. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61 /* 03-24-1998 Released version 1.3. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 /* 06-04-1998 Modified QUCE_Send_To_Queue to */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 /* check for a size of 0, created */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 /* version 1.3a. (SPR493) */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 /* 04-17-2002 Released version 1.13m */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 /* 11-07-2002 Released version 1.14 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 #define NU_SOURCE_FILE
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 #include "cs_extr.h" /* Common service functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72 #include "tc_extr.h" /* Thread control functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 #include "qu_extr.h" /* Queue functions */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 /* FUNCTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 /* QUCE_Create_Queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82 /* DESCRIPTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 /* This function performs error checking on the parameters supplied */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85 /* to the queue create function. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 /* CALLED BY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 /* Application */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91 /* CALLS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93 /* QUC_Create_Queue Actual create queue function */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 /* INPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 /* queue_ptr Queue control block pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 /* name Queue name */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 /* start_address Starting address of actual */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100 /* queue area */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101 /* queue_size Total size of queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102 /* message_type Type of message supported by */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103 /* the queue (fixed/variable) */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104 /* message_size Size of message. Variable */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 /* message-length queues, this*/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 /* represents the maximum size*/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 /* suspend_type Suspension type */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109 /* OUTPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111 /* NU_INVALID_QUEUE Invalid queue pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112 /* NU_INVALID_MEMORY Invalid queue starting addr */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 /* NU_INVALID_SIZE Invalid queue size and/or */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 /* size of message */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 /* NU_INVALID_MESSAGE Invalid message type */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116 /* NU_INVALID_SUSPEND Invalid suspend type */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118 /* HISTORY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120 /* DATE REMARKS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122 /* 03-01-1993 Created initial version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123 /* 04-19-1993 Verified version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 /* 03-01-1994 Modified function interface, */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125 /* resulting in version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 /* 03-18-1994 Verified version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 STATUS QUCE_Create_Queue(NU_QUEUE queue_ptr, CHAR name,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 VOID *start_address, UNSIGNED queue_size,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132 OPTION message_type, UNSIGNED message_size,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133 OPTION suspend_type)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134 {
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136 QU_QCB *queue;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137 STATUS status;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 INT overhead;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141 /* Move input queue pointer into internal pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 queue = (QU_QCB *) queue_ptr;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 /* Determine if queue supports variable length messages. If so, an
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 additional word of overhead is required. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146 if (message_type == NU_VARIABLE_SIZE)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 /* Variable-size queues require an additional word of overhead. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149 overhead = 1;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 else
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152 /* Fixed-size message queues require no additional overhead. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153 overhead = 0;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155 /* Determine if there is an error with the queue pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 if ((queue == NU_NULL) \|\| (queue -> qu_id == QU_QUEUE_ID))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 else if (start_address == NU_NULL)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	163 /* Indicate that the starting address of the queue is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	164 status = NU_INVALID_MEMORY;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	165
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166 else if ((queue_size == 0) \|\| (message_size == 0) \|\|
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	167 ((message_size+overhead) > queue_size))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	168
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	169 /* Indicate that one or both of the size parameters are invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	170 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	171
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	172 else if ((message_type != NU_FIXED_SIZE) &&
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	173 (message_type != NU_VARIABLE_SIZE))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	174
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175 /* Indicate that the message type is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	176 status = NU_INVALID_MESSAGE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	177
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	178 else if ((suspend_type != NU_FIFO) && (suspend_type != NU_PRIORITY))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	179
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180 /* Indicate that the suspend type is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	181 status = NU_INVALID_SUSPEND;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	182
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	183 else
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	184
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	185 /* All the parameters are okay, call the actual function to create
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	186 a queue. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	187 status = QUC_Create_Queue(queue_ptr, name, start_address, queue_size,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	188 message_type, message_size, suspend_type);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	190 /* Return completion status. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 return(status);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192 }
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	196 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197 /* FUNCTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	198 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199 /* QUCE_Delete_Queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	200 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201 /* DESCRIPTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	202 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	203 /* This function performs error checking on the parameter supplied */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204 /* to the queue delete function. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	206 /* CALLED BY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	207 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	208 /* Application */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	209 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	210 /* CALLS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	211 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	212 /* QUC_Delete_Queue Actual delete queue function */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	213 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	214 /* INPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	215 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	216 /* queue_ptr Queue control block pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	217 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	218 /* OUTPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	219 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	220 /* NU_INVALID_QUEUE Invalid queue pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	221 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	222 /* HISTORY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	223 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	224 /* DATE REMARKS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	225 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	226 /* 03-01-1993 Created initial version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	227 /* 04-19-1993 Verified version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	228 /* 03-01-1994 Modified function interface, */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	229 /* resulting in version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	230 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	231 /* 03-18-1994 Verified version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	232 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	233 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	234 STATUS QUCE_Delete_Queue(NU_QUEUE *queue_ptr)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	235 {
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	236
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	237 QU_QCB *queue;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	238 STATUS status;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	239
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	240
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	241 /* Move input queue pointer into internal pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	242 queue = (QU_QCB *) queue_ptr;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	243
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	244 /* Determine if there is an error with the queue pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	245 if (queue == NU_NULL)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	246
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	247 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	248 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	249
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	250 else if (queue -> qu_id != QU_QUEUE_ID)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	251
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	252 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	253 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	254
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	255 else
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	256
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	257 /* All the parameters are okay, call the actual function to delete
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	258 a queue. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	259 status = QUC_Delete_Queue(queue_ptr);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	260
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	261 /* Return completion status. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	262 return(status);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	263 }
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	264
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	265
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	266 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	267 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	268 /* FUNCTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	269 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	270 /* QUCE_Send_To_Queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	271 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	272 /* DESCRIPTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	273 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	274 /* This function performs error checking on the parameters supplied */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	275 /* to the send message to queue function. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	276 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	277 /* CALLED BY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	278 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	279 /* Application */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	280 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	281 /* CALLS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	282 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	283 /* QUC_Send_To_Queue Actual send queue message */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	284 /* function */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	285 /* TCCE_Suspend_Error Check suspend validity */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	286 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	287 /* INPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	288 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	289 /* queue_ptr Queue control block pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	290 /* message Pointer to message to send */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	291 /* size Size of message to send */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	292 /* suspend Suspension option if full */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	293 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	294 /* OUTPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	295 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	296 /* NU_INVALID_QUEUE Invalid queue pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	297 /* NU_INVALID_POINTER Invalid message pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	298 /* NU_INVALID_SIZE Invalid message size */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	299 /* NU_INVALID_SUSPEND Invalid suspend request */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	300 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	301 /* HISTORY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	302 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	303 /* DATE REMARKS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	304 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	305 /* 03-01-1993 Created initial version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	306 /* 04-19-1993 Verified version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	307 /* 03-01-1994 Modified function interface, */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	308 /* resulting in version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	309 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	310 /* 03-18-1994 Verified version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	311 /* 06-04-1998 Corrected SPR493 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	312 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	313 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	314 STATUS QUCE_Send_To_Queue(NU_QUEUE queue_ptr, VOID message, UNSIGNED size,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	315 UNSIGNED suspend)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	316 {
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	317
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	318 QU_QCB *queue;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	319 STATUS status;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	320
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	321
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	322 /* Move input queue pointer into internal pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	323 queue = (QU_QCB *) queue_ptr;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	324
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	325 /* Determine if there is an error with the queue pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	326 if (queue == NU_NULL)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	327
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	328 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	329 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	330
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	331 else if (queue -> qu_id != QU_QUEUE_ID)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	332
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	333 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	334 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	335
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	336 else if (message == NU_NULL)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	337
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	338 /* Indicate that the pointer to the message is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	339 status = NU_INVALID_POINTER;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	340
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	341 else if (size == 0)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	342
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	343 /* Indicate that the message size is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	344 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	345
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	346 else if ((queue -> qu_fixed_size) && (size != queue -> qu_message_size))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	347
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	348 /* Indicate that the message size is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	349 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	350
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	351 else if ((!queue -> qu_fixed_size) && (size > queue -> qu_message_size))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	352
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	353 /* Indicate that the message size is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	354 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	355
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	356 else if ((suspend) && (TCCE_Suspend_Error()))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	357
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	358 /* Indicate that the suspension is only allowed from a task thread. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	359 status = NU_INVALID_SUSPEND;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	360
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	361 else
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	362
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	363 /* All the parameters are okay, call the actual function to send
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	364 a message to a queue. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	365 status = QUC_Send_To_Queue(queue_ptr, message, size, suspend);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	366
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	367 /* Return completion status. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	368 return(status);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	369 }
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	370
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	371
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	372 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	373 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	374 /* FUNCTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	375 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	376 /* QUCE_Receive_From_Queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	377 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	378 /* DESCRIPTION */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	379 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	380 /* This function performs error checking on the parameters supplied */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	381 /* to the receive message from queue function. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	382 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	383 /* CALLED BY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	384 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	385 /* Application */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	386 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	387 /* CALLS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	388 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	389 /* QUC_Receive_From_Queue Actual receive message from */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	390 /* queue */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	391 /* TCCE_Suspend_Error Check suspend validity */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	392 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	393 /* INPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	394 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	395 /* queue_ptr Queue control block pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	396 /* message Pointer to message to send */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	397 /* size Size of the message */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	398 /* actual_size Size of message received */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	399 /* suspend Suspension option if empty */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	400 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	401 /* OUTPUTS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	402 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	403 /* NU_INVALID_QUEUE Invalid queue pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	404 /* NU_INVALID_POINTER Invalid message pointer */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	405 /* NU_INVALID_SIZE Invalid message size */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	406 /* NU_INVALID_SUSPEND Invalid suspend request */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	407 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	408 /* HISTORY */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	409 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	410 /* DATE REMARKS */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	411 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	412 /* 03-01-1993 Created initial version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	413 /* 04-19-1993 Verified version 1.0 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	414 /* 03-01-1994 Modified function interface, */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	415 /* resulting in version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	416 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	417 /* 03-18-1994 Verified version 1.1 */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	418 /* 05-24-1996 Changed the variable queue check */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	419 /* from "message size not equal */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	420 /* to pipe message size" to */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	421 /* "message size greater than */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	422 /* pipe message size" (SPR142). */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	423 /* */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	424 /*************************************************************************/
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	425 STATUS QUCE_Receive_From_Queue(NU_QUEUE queue_ptr, VOID message,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	426 UNSIGNED size, UNSIGNED *actual_size, UNSIGNED suspend)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	427 {
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	428
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	429 QU_QCB *queue;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	430 STATUS status;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	431
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	432
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	433 /* Move input queue pointer into internal pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	434 queue = (QU_QCB *) queue_ptr;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	435
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	436 /* Determine if there is an error with the queue pointer. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	437 if (queue == NU_NULL)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	438
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	439 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	440 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	441
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	442 else if (queue -> qu_id != QU_QUEUE_ID)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	443
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	444 /* Indicate that the queue pointer is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	445 status = NU_INVALID_QUEUE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	446
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	447 else if (message == NU_NULL)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	448
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	449 /* Indicate that the pointer to the message is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	450 status = NU_INVALID_POINTER;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	451
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	452 else if (size == 0)
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	453
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	454 /* Indicate that the message size is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	455 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	456
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	457 else if ((queue -> qu_fixed_size) && (size != queue -> qu_message_size))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	458
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	459 /* Indicate that the message size is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	460 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	461
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	462 else if ((!queue -> qu_fixed_size) && (size > queue -> qu_message_size))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	463
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	464 /* Indicate that the message size is invalid. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	465 status = NU_INVALID_SIZE;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	466
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	467 else if ((suspend) && (TCCE_Suspend_Error()))
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	468
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	469 /* Indicate that the suspension is only allowed from a task thread. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	470 status = NU_INVALID_SUSPEND;
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	471
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	472 else
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	473
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	474 /* All the parameters are okay, call the actual function to receive
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	475 a message from a queue. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	476 status = QUC_Receive_From_Queue(queue_ptr, message, size,
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	477 actual_size, suspend);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	478
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	479 /* Return completion status. */
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	480 return(status);
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	481 }
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	482
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	483
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	484
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	485
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	486
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	487
0f80e1e4dce4 src/nucleus: library C code import from FreeNucleus package Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	488

FreeCalypso > hg > fc-selenite

annotate src/nucleus/quce.c @ 86:425ab6d987f3