diff src/nucleus/pi_extr.h @ 7:0f80e1e4dce4

src/nucleus: library C code import from FreeNucleus package
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 15 Jul 2018 20:57:33 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/nucleus/pi_extr.h	Sun Jul 15 20:57:33 2018 +0000
@@ -0,0 +1,135 @@
+/*************************************************************************/
+/*                                                                       */
+/*               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       */
+/*                                                                       */
+/*      pi_extr.h                                      Nucleus PLUS 1.14 */
+/*                                                                       */
+/* COMPONENT                                                             */
+/*                                                                       */
+/*      PI - Pipe Management                                             */
+/*                                                                       */
+/* DESCRIPTION                                                           */
+/*                                                                       */
+/*      This file contains function prototypes of all functions          */
+/*      accessible to other components.                                  */
+/*                                                                       */
+/* DATA STRUCTURES                                                       */
+/*                                                                       */
+/*      None                                                             */
+/*                                                                       */
+/* FUNCTIONS                                                             */
+/*                                                                       */
+/*      None                                                             */
+/*                                                                       */
+/* DEPENDENCIES                                                          */
+/*                                                                       */
+/*      pi_defs.h                           Pipe Management constants    */
+/*                                                                       */
+/* HISTORY                                                               */
+/*                                                                       */
+/*         DATE                    REMARKS                               */
+/*                                                                       */
+/*      03-01-1993      Created initial version 1.0                      */
+/*      04-19-1993      Verified version 1.0                             */
+/*      03-01-1994      Moved include files outside of                   */
+/*                      the file #ifndef to allow the                    */
+/*                      use of actual data structures,                   */
+/*                      modified function prototypes,                    */
+/*                      resulting in version 1.1                         */
+/*                                                                       */
+/*      03-18-1994      Verified version 1.1                             */
+/*      04-17-1996      updated to version 1.2                           */
+/*      03-24-1998      Released version 1.3                             */
+/*      03-26-1999      Released 1.11m (new release                      */
+/*                        numbering scheme)                              */
+/*      04-17-2002      Released version 1.13m                           */
+/*      11-07-2002      Released version 1.14                            */
+/*************************************************************************/
+
+#include        "pi_defs.h"                 /* Include Pipe constants    */
+
+
+/* Check to see if the file has been included already.  */
+
+#ifndef PI_EXTR
+#define PI_EXTR
+
+
+/*  Initialization functions.  */
+
+VOID            PII_Initialize(VOID);
+
+
+/* Error checking core functions.  */
+
+STATUS          PICE_Create_Pipe(NU_PIPE *pipe_ptr, CHAR *name, 
+                      VOID *start_address, UNSIGNED pipe_size, 
+                      OPTION message_type, UNSIGNED message_size,
+                      OPTION suspend_type);
+STATUS          PICE_Delete_Pipe(NU_PIPE *pipe_ptr);
+STATUS          PICE_Send_To_Pipe(NU_PIPE *pipe_ptr, VOID *message, 
+                                        UNSIGNED size, UNSIGNED suspend);
+STATUS          PICE_Receive_From_Pipe(NU_PIPE *pipe_ptr, VOID *message,
+                      UNSIGNED size, UNSIGNED *actual_size, UNSIGNED suspend);
+
+
+/* Error checking supplemental functions.  */
+
+STATUS          PISE_Reset_Pipe(NU_PIPE *pipe_ptr);
+STATUS          PISE_Send_To_Front_Of_Pipe(NU_PIPE *pipe_ptr, VOID *message, 
+                                        UNSIGNED size, UNSIGNED suspend);
+STATUS          PISE_Broadcast_To_Pipe(NU_PIPE *pipe_ptr, VOID *message, 
+                                        UNSIGNED size, UNSIGNED suspend);
+
+
+/* Core processing functions.  */
+
+STATUS          PIC_Create_Pipe(NU_PIPE *pipe_ptr, CHAR *name, 
+                      VOID *start_address, UNSIGNED pipe_size, 
+                      OPTION message_type, UNSIGNED message_size,
+                      OPTION suspend_type);
+STATUS          PIC_Delete_Pipe(NU_PIPE *pipe_ptr);
+STATUS          PIC_Send_To_Pipe(NU_PIPE *pipe_ptr, VOID *message, 
+                                        UNSIGNED size, UNSIGNED suspend);
+STATUS          PIC_Receive_From_Pipe(NU_PIPE *pipe_ptr, VOID *message,
+                      UNSIGNED size, UNSIGNED *actual_size, UNSIGNED suspend);
+
+
+/* Supplemental processing functions.  */
+
+STATUS          PIS_Reset_Pipe(NU_PIPE *pipe_ptr);
+STATUS          PIS_Send_To_Front_Of_Pipe(NU_PIPE *pipe_ptr, VOID *message, 
+                                        UNSIGNED size, UNSIGNED suspend);
+STATUS          PIS_Broadcast_To_Pipe(NU_PIPE *pipe_ptr, VOID *message, 
+                                        UNSIGNED size, UNSIGNED suspend);
+
+
+/* Information retrieval functions.  */
+
+UNSIGNED        PIF_Established_Pipes(VOID);
+STATUS          PIF_Pipe_Information(NU_PIPE *pipe_ptr, CHAR *name, 
+                  VOID **start_address, UNSIGNED *pipe_size, 
+                  UNSIGNED *available, UNSIGNED *messages, 
+                  OPTION *message_type, UNSIGNED *message_size,
+                  OPTION *suspend_type, UNSIGNED *tasks_waiting,
+                  NU_TASK **first_task);
+UNSIGNED        PIF_Pipe_Pointers(NU_PIPE **pointer_list, 
+                                                UNSIGNED maximum_pointers);
+
+#endif
+
+
+
+
+