osfmk/mach/flipc_device.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  *
  25  */
  26 /*
  27  * HISTORY
  28  *
  29  * Revision 1.1.1.1  1998/09/22 21:05:29  wsanchez
  30  * Import of Mac OS X kernel (~semeria)
  31  *
  32  * Revision 1.1.1.1  1998/03/07 02:25:45  wsanchez
  33  * Import of OSF Mach kernel (~mburg)
  34  *
  35  * Revision 1.1.5.1  1995/06/13  18:20:16  sjs
  36  *      Merged from flipc_shared.
  37  *      [95/06/07            sjs]
  38  *
  39  * Revision 1.1.3.4  1995/04/05  21:21:58  randys
  40  *      Added allocations_lock_policy argument to usermsg_Init_Buffer set
  41  *      status call.
  42  *      [95/04/05            randys]
  43  *
  44  * Revision 1.1.3.3  1995/02/21  17:23:08  randys
  45  *      Re-indented code to four space indentation
  46  *      [1995/02/21  16:25:35  randys]
  47  *
  48  * Revision 1.1.3.2  1994/12/20  19:02:03  randys
  49  *      Added filename in comment at top of each file
  50  *      [1994/12/19  20:28:25  randys]
  51  *
  52  * Revision 1.1.3.1  1994/12/12  17:46:17  randys
  53  *      Putting initial flipc implementation under flipc_shared
  54  *      [1994/12/12  16:27:48  randys]
  55  *
  56  * Revision 1.1.1.2  1994/12/11  23:11:21  randys
  57  *      Initial flipc code checkin
  58  *
  59  * $EndLog$
  60  */
  61
  62 /*
  63  * mach/flipc_device.h
  64  *
  65  * Declarations related to the device driver interface to FLIPC.
  66  */
  67
  68 #ifndef _MACH_FLIPC_DEVICE_H_
  69 #define _MACH_FLIPC_DEVICE_H_
  70
  71 /*
  72  * Definitions of constants both the ME and AIL need to know for
  73  * communications through the device driver interface.  These are the
  74  * possible values for the top 16 bits of the flavor parameter; the
  75  * bottom 16 bits are extra information that may be needed (eg. to
  76  * parameterize a request for semaphore in the get status routine).
  77  */
  78 typedef enum {                  /* Arguments.  */
  79     /* Get status flavors.  */
  80     usermsg_Get_Initialized_Status = 1, /* (int *init_p) */
  81     usermsg_Get_Epgroup_Semaphore, /* (mach_port_t *semaphore) */
  82     usermsg_Return_Allocations_Lock, /* (void) */
  83
  84     /* Set status flavors.  */
  85     usermsg_Init_Buffer,                /* (int max_endpoints,
  86                                            int max_epgroups,
  87                                            int max_buffers,
  88                                            int max_buffers_per_endpoint,
  89                                            int allocations_lock_policy) */
  90     usermsg_Process_Work,               /* (void) */
  91     usermsg_Acquire_Allocations_Lock, /* (void) */
  92     usermsg_Release_Allocations_Lock, /* (void) */
  93     usermsg_Epgroup_Associate_Semaphore /* (int epgroup_idx, mach_port_t port) */
  94 } usermsg_devop_t;
  95
  96 #define FLIPC_DEVICE_FLAVOR(devop, param)  (((devop)<<16)|(param))
  97
  98 #endif /* _MACH_FLIPC_DEVICE_H_ */