osfmk/mach/flipc_device.h

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