osfmk/mach/flipc_device.h

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