diff src/nucleus/mbse.c @ 0:4e78acac3d88

src/{condat,cs,gpf,nucleus}: import from Selenite
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 16 Oct 2020 06:23:26 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/nucleus/mbse.c	Fri Oct 16 06:23:26 2020 +0000
@@ -0,0 +1,222 @@
+/*************************************************************************/
+/*                                                                       */
+/*               Copyright Mentor Graphics Corporation 2002              */
+/*                         All Rights Reserved.                          */
+/*                                                                       */
+/* THIS WORK CONTAINS TRADE SECRET AND PROPRIETARY INFORMATION WHICH IS  */
+/* THE PROPERTY OF MENTOR GRAPHICS CORPORATION OR ITS LICENSORS AND IS   */
+/* SUBJECT TO LICENSE TERMS.                                             */
+/*                                                                       */
+/*************************************************************************/
+
+/*************************************************************************/
+/*                                                                       */
+/* FILE NAME                                               VERSION       */
+/*                                                                       */
+/*      mbse.c                                         Nucleus PLUS 1.14 */
+/*                                                                       */
+/* COMPONENT                                                             */
+/*                                                                       */
+/*      MB - Mailbox Management                                          */
+/*                                                                       */
+/* DESCRIPTION                                                           */
+/*                                                                       */
+/*      This file contains the error checking routines for the functions */
+/*      in the Mailbox component.  This permits easy removal of error    */
+/*      checking logic when it is not needed.                            */
+/*                                                                       */
+/* DATA STRUCTURES                                                       */
+/*                                                                       */
+/*      None                                                             */
+/*                                                                       */
+/* FUNCTIONS                                                             */
+/*                                                                       */
+/*      MBSE_Reset_Mailbox                  Reset a mailbox              */
+/*      MBSE_Receive_From_Mailbox           Receive a mailbox message    */
+/*                                                                       */
+/* DEPENDENCIES                                                          */
+/*                                                                       */
+/*      cs_extr.h                           Common Service functions     */
+/*      tc_extr.h                           Thread Control functions     */
+/*      mb_extr.h                           Mailbox functions            */
+/*                                                                       */
+/* HISTORY                                                               */
+/*                                                                       */
+/*         DATE                    REMARKS                               */
+/*                                                                       */
+/*      03-01-1994      Created initial version 1.1 from                 */
+/*                      routines originally in core                      */
+/*                      error checking file                              */
+/*                                                                       */
+/*      03-18-1994      Verified version 1.1                             */
+/*      04-17-1996      updated to version 1.2                           */
+/*      03-24-1998      Released version 1.3                             */
+/*      04-17-2002      Released version 1.13m                           */
+/*      11-07-2002      Released version 1.14                            */
+/*************************************************************************/
+#define         NU_SOURCE_FILE
+
+
+#include        "cs_extr.h"                 /* Common service functions  */
+#include        "tc_extr.h"                 /* Thread control functions  */
+#include        "mb_extr.h"                 /* Mailbox functions         */
+
+
+
+/*************************************************************************/
+/*                                                                       */
+/* FUNCTION                                                              */
+/*                                                                       */
+/*      MBSE_Reset_Mailbox                                               */
+/*                                                                       */
+/* DESCRIPTION                                                           */
+/*                                                                       */
+/*      This function performs error checking on the parameters supplied */
+/*      to the actual reset mailbox function.                            */
+/*                                                                       */
+/* CALLED BY                                                             */
+/*                                                                       */
+/*      Application                                                      */
+/*                                                                       */
+/* CALLS                                                                 */
+/*                                                                       */
+/*      MBS_Reset_Mailbox                   Actual reset mailbox function*/
+/*                                                                       */
+/* INPUTS                                                                */
+/*                                                                       */
+/*      mailbox_ptr                         Mailbox control block pointer*/
+/*                                                                       */
+/* OUTPUTS                                                               */
+/*                                                                       */
+/*      NU_INVALID_MAILBOX                  Invalid mailbox supplied     */
+/*                                                                       */
+/* HISTORY                                                               */
+/*                                                                       */
+/*         DATE                    REMARKS                               */
+/*                                                                       */
+/*      03-01-1993      Created initial version 1.0                      */
+/*      04-19-1993      Verified version 1.0                             */
+/*      03-01-1994      Modified interface to exactly                    */
+/*                      match prototype, resulting in                    */
+/*                      version 1.1                                      */
+/*                                                                       */
+/*      03-18-1994      Verified version 1.1                             */
+/*                                                                       */
+/*************************************************************************/
+STATUS  MBSE_Reset_Mailbox(NU_MAILBOX *mailbox_ptr)
+{
+
+MB_MCB         *mailbox;                    /* Mailbox control block ptr */
+STATUS          status;                     /* Completion status         */
+
+
+    /* Move input mailbox pointer into internal pointer.  */
+    mailbox =  (MB_MCB *) mailbox_ptr;
+
+    /* Determine if the mailbox pointer is valid.  */
+    if ((mailbox) && (mailbox -> mb_id == MB_MAILBOX_ID))
+    
+        /* Mailbox pointer is valid, call function to reset it.  */
+        status =  MBS_Reset_Mailbox(mailbox_ptr);
+        
+    else
+    
+        /* Mailbox pointer is invalid, indicate in completion status.  */
+        status =  NU_INVALID_MAILBOX;
+        
+    /* Return completion status.  */
+    return(status);
+}
+
+
+/*************************************************************************/
+/*                                                                       */
+/* FUNCTION                                                              */
+/*                                                                       */
+/*      MBSE_Broadcast_To_Mailbox                                        */
+/*                                                                       */
+/* DESCRIPTION                                                           */
+/*                                                                       */
+/*      This function performs error checking on the parameters supplied */
+/*      to the mailbox broadcast function.                               */
+/*                                                                       */
+/* CALLED BY                                                             */
+/*                                                                       */
+/*      Application                                                      */
+/*                                                                       */
+/* CALLS                                                                 */
+/*                                                                       */
+/*      MBS_Broadcast_To_Mailbox            Actual broadcast mailbox func*/
+/*      TCCE_Suspend_Error                  Check suspend validity       */
+/*                                                                       */
+/* INPUTS                                                                */
+/*                                                                       */
+/*      mailbox_ptr                         Mailbox control block pointer*/
+/*      message                             Pointer to message to send   */
+/*      suspend                             Suspension option if full    */
+/*                                                                       */
+/* OUTPUTS                                                               */
+/*                                                                       */
+/*      NU_INVALID_MAILBOX                  Mailbox pointer is invalid   */
+/*      NU_INVALID_POINTER                  Message pointer is invalid   */
+/*      NU_INVALID_SUSPEND                  Invalid suspend request      */
+/*                                                                       */
+/* HISTORY                                                               */
+/*                                                                       */
+/*        DATE                    REMARKS                                */
+/*                                                                       */
+/*      03-01-1993      Created initial version 1.0                      */
+/*      04-19-1993      Verified version 1.0                             */
+/*      03-01-1994      Modified interface to exactly                    */
+/*                      match prototype, resulting in                    */
+/*                      version 1.1                                      */
+/*                                                                       */
+/*      03-18-1994      Verified version 1.1                             */
+/*                                                                       */
+/*************************************************************************/
+STATUS  MBSE_Broadcast_To_Mailbox(NU_MAILBOX *mailbox_ptr, VOID *message, 
+                                                        UNSIGNED suspend)
+{
+
+MB_MCB         *mailbox;                    /* Mailbox control block ptr */
+STATUS          status;                     /* Completion status         */
+
+
+
+    /* Move input mailbox pointer into internal pointer.  */
+    mailbox =  (MB_MCB *) mailbox_ptr;
+
+    /* Determine if mailbox pointer is invalid.  */
+    if (mailbox == NU_NULL)
+    
+        /* Mailbox pointer is invalid, indicate in completion status.  */
+        status =  NU_INVALID_MAILBOX;
+
+    else if (mailbox -> mb_id != MB_MAILBOX_ID)
+    
+        /* Mailbox pointer is invalid, indicate in completion status.  */
+        status =  NU_INVALID_MAILBOX;
+
+    else if (message == NU_NULL)
+    
+        /* Message pointer is invalid, indicate in completion status.  */
+        status =  NU_INVALID_POINTER;
+
+    else if ((suspend) && (TCCE_Suspend_Error()))
+    
+        /* Indicate that suspension is only valid from a task thread.  */
+        status =  NU_INVALID_SUSPEND;
+
+    else
+        
+        /* Parameters are valid, call actual function.  */
+        status =  MBS_Broadcast_To_Mailbox(mailbox_ptr, message, suspend);
+    
+    /* Return the completion status.  */
+    return(status);
+}
+
+
+
+
+