osfmk/mach/flipc_device.h

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