Source to bsd/dev/evio.h

Enter a symbol's name here to quickly find it. 
/*
 * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * "Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
 * Reserved.  This file contains Original Code and/or Modifications of
 * Original Code as defined in and that are subject to the Apple Public
 * Source License Version 1.0 (the 'License').  You may not use this file
 * except in compliance with the License.  Please obtain a copy of the
 * License at http://www.apple.com/publicsource and read it before using
 * this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License."
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/******************************************************************************

    evio.h
    Ioctl calls for the events driver
    Leovitch 02Jan88
    
    Copyright 1988 NeXT, Inc.
    
	CAUTION: Developers should stick to the API exported in
		<drivers/event_status_driver.h> to guarantee
		binary compatability of their applications in future
		releases.

    Modified:
    
    09Dec88 Leo  Broken out from evsio.h
    24Aug89 Ted  ANSI function prototyping.
    19Feb90 Ted  Major revision for multiple driver support.
    26Feb90 Ted  New evioScreen structure and EVIOST ioctl.
    12Mar90 Ted  New ev_unregister_screen function, SCREENTOKEN constant.
    06May90 Ted  Added AALastEventSent and AALastEventConsumed to EvVars.
    22May90 Trey More wait cursor vars in EvVars.
    13Jun90 Ted  NXCursorData structure.
    18Jun90 Ted  Default wait cursor constants.
    26Sep90 Ted  Enhanced cursor system to support intelligent drivers.
    26Nov90 Ted  Removed NXSaveCursor and NXCursorData structures
    28Nov90 Ted  Remove EvVars, rolled into EventGlobals
    28Nov90 Ted  Renamed EventGlobals -> EvGlobals, eventGlobals -> evg
    05May92 Mike Reworked for NRW driver architecture.

******************************************************************************/

#ifdef	DRIVER_PRIVATE

#ifndef _DEV_EVIO_
#define _DEV_EVIO_
#import <mach/port.h>
#import <mach/message.h>
#import <bsd/dev/ev_types.h>
#import <bsd/dev/event.h>
#import <driverkit/generalFuncs.h>
#import <mach/boolean.h>

/*
 * Identify this driver as one that uses the new driverkit and messaging API
 */
#ifndef _NeXT_MACH_EVENT_DRIVER_
#define _NeXT_MACH_EVENT_DRIVER_	(1)
#endif /* _NeXT_MACH_EVENT_DRIVER_ */


/*
 * Time sources, in ticks and milliseconds.  These work in both
 * the kernel and user environments, as long as the driverkit is
 * linked in.  The tick time is on the same order as the old vertical blanking
 * counter, but is derived from the nanosecond timer timebase.
 */
#if defined(_KERNEL)
extern void IOGetTimestamp(ns_time_t *nsp);	// Can not include generalFuncs.h
						// due to PS conflicts with
						// Adobe code.
	
 static inline unsigned
EvTickTimeValue()
{
	ns_time_t	ns_time;
	unsigned	tick;
	IOGetTimestamp(&ns_time);
	// Convert nanosec => ticks and return
	tick = EV_NS_TO_TICK(ns_time);
	if ( tick == 0 )
		tick = 1;	// No zero values allowed!
	return tick;
}

 static inline unsigned
EvMsecTimeValue()
{
	ns_time_t	ns_time;
	
	IOGetTimestamp(&ns_time);
	// Convert nanosec => millisec and return
	return (unsigned)(ns_time /= 1000000ULL);
}
#endif /* _KERNEL */
/* Pressure Constants */
#define MINPRESSURE EV_MINPRESSURE
#define MAXPRESSURE EV_MAXPRESSURE

#define	LLEQSIZE 80	/* Entries in low-level event queue */

typedef struct _NXEQElStruct {
    int	next;		/* Slot of lleq for next event */
    ev_lock_data_t sema; /* Is high-level code reading this event now? */
    NXEvent event;	/* The event itself */
} NXEQElement;


/******************************************************************************
    SHARED MEMORY OVERVIEW
    
    PERSPECTIVE
    The ev driver and PostScript share at least one page of wired memory.
    This memory contains the low-level event queue which ev deposits events
    into and PostScript reads events from. Also, this memory contains other
    important data such as wait cursor state and some general cursor state.
    This memory is critical for speed.  That is, we avoid having to make
    system calls for common operations.
    
    SHARED MEMORY REGIONS
    There are currently three "regions" or "zones" delineated within this
    shared memory.  The first zone is the EvOffsets structure. This structure
    contains two offsets from the beginning of shared memory. The first offset
    is to the second zone, EvGlobals. The second offset is to the third
    zone, private shmem for drivers.
    
    INITIALIZATION OF SHARED MEMORY
    When the WindowServer starts up, it finds all screens that will be active.
    It then opens the ev driver and calls the EVIOSSCR ioctl repeatedly for
    each screen in use. This lets the ev driver set up the evScreen array
    and fill in each element. This ioctl also returns to PostScript a running
    total shared memory size with which to allocate. PostScript then allocates
    a region of memory this size and calls evmmap to "map in" this shared
    region.  Evmmap initializes and fills in the EvOffsets and EvGlobals.
    Next the WindowServer calls each screen in turn to register itself with
    the ev driver in the same sequence as presented to EVIOSSCR.  Each screen
    driver calls ev_register_screen() which among other things allocates a
    part of the private shmem (of the third shared memory zone) for the driver.
    
    DEBUGGING NOTES
    You can easily display and set this shared memory from kgdb, but usually
    cannot do so from within PostScript.  Gdb (or some weird interaction
    between gdb and the os) chokes on this shmem.  So if you read or write
    this area of memory, copy-on-write will occur and you'll get a completely
    new page for PostScript.  This will render the shared memory scheme
    useless and you will have to restart PostScript.  It was my understanding
    that before, we were able to "read" this area from PS, but not write to
    it (the idea behind copy-on-WRITE).  However, this seems to be broken
    in 2.0.  We think this is a kernel bug.
******************************************************************************/

typedef volatile struct _evOffsets {
    int	evGlobalsOffset;	/* Offset to EvGlobals structure */
    int evShmemOffset;		/* Offset to private shmem regions */
} EvOffsets;

/******************************************************************************
    EvGlobals
    This structures defines the portion of the events driver data structure
    that is exported to the PostScript server. It contains the event queue
    which is in memory shared between the driver and the PostScript server.
    All the variables necessary to read and process events from the queue are
    contained here.
******************************************************************************/

typedef volatile struct _evGlobals {
    short LLEHead;		/* The next event to be read */
    short LLETail;		/* Where the next event will go */
    short LLELast;		/* The last event entered */
    short eNum;			/* Unique id for mouse events */
    int buttons;		/* State of the mouse buttons 1==down, 0==up */
    int eventFlags;		/* The current value of event.flags */
    int VertRetraceClock;	/* The current value of event.time */
    ev_lock_data_t cursorSema; 	/* set to disable periodic code */
    Point cursorLoc;		/* The current location of the cursor */
    int frame;			/* current cursor frame */
    Bounds workBounds;		/* bounding box of all screens */
    Bounds mouseRect;		/* Rect for mouse-exited events */
    unsigned reserved:27;
    unsigned wantPressure:1;	/* pressure in current mouseRect? */
    unsigned wantPrecision:1;	/* precise coordinates in current mouseRect? */
    unsigned dontWantCoalesce:1;/* coalesce within the current mouseRect? */
    unsigned dontCoalesce:1;	/* actual flag which determines coalescing */
    unsigned mouseRectValid:1;	/* If nonzero, post a mouse-exited
				   whenever mouse outside mouseRect. */
    int movedMask;		/* This contains an event mask for the
				   three events MOUSEMOVED,
				   LMOUSEDRAGGED,  and RMOUSEDRAGGED.
				   It says whether driver should
				   generate those events. */
    int AALastEventSent;	/* timestamp for wait cursor */
    int AALastEventConsumed;	/* timestamp for wait cursor */	
    ev_lock_data_t waitCursorSema; /* protects wait cursor fields */
    int waitCursorUp;		/* Is wait cursor up? */
    char ctxtTimedOut;		/* Has wait cursor timer expired? */
    char waitCursorEnabled;	/* Play wait cursor game (per ctxt)? */
    char globalWaitCursorEnabled; /* Play wait cursor game (global)? */
    short waitThreshold;	/* time before wait cursor appears */
    NXEQElement lleq[LLEQSIZE];	/* The event queue itself */
} EvGlobals;


/* These evio structs are used in various calls supported by the ev driver. */

struct evioLLEvent {
    int type;
    Point location;
    NXEventData data;
};

typedef struct evioLLEvent _NXLLEvent;

/*
 * On a keypress of a VOL UP or VOL DOWN key, we send a message to the 
 * sound server to notify it of the volume change.  The message includes
 * a flag to indicate which key was pressed, and the machine independant
 * flag bits to indicate which modifier keys were pressed.
 */
struct evioSpecialKeyMsg
{
	msg_header_t Head;
	msg_type_t keyType;
	int key;		// special key number, from bsd/dev/ev_keymap.h
	msg_type_t directionType;
	int direction;		// NX_KEYDOWN, NX_KEYUP from event.h
	msg_type_t flagsType;
	int flags;		// device independant flags from event.h
	msg_type_t levelType;
	int level;		// EV_AUDIO_MIN_VOLUME to EV_AUDIO_MAX_VOLUME
};

#define EV_SPECIAL_KEY_MSG_ID	(('S'<<24) | ('k'<<16) | ('e'<<8) | ('y'))
typedef struct evioSpecialKeyMsg *evioSpecialKeyMsg_t;

/*
 * Volume ranges
 */
#define EV_AUDIO_MIN_VOLUME	0
#define EV_AUDIO_MAX_VOLUME	64

/*
 * Get and Set parameter calls for the Event driver and associated filters.
 */

#define EV_PREFIX	"Ev_"	/* All EV calls start with this string */

/* _NXEvSetParameterInt() calls */
#define EVIOLLPE	"Ev_LLPostEvent"
#define EVIOPTRLLPE	"Ev_PointerLLPostEvent"
/* EventData packed as an array of ints. */
typedef union
{
    NXEventData	data;
    unsigned idata[(sizeof(NXEventData)+sizeof(unsigned)-1)/sizeof(unsigned)];
} _NX_packed_event_t;

typedef enum {
	EVIOLLPE_TYPE,
	EVIOLLPE_LOC_X,
	EVIOLLPE_LOC_Y,
	EVIOLLPE_DATA0,
	EVIOLLPE_DATA1,
	EVIOLLPE_DATA2
} evioLLPEIndices;
#define EVIOLLPE_SIZE	(EVIOLLPE_DATA2 + 1)

#define EVIOSM	"Ev_MousePosition"		
typedef enum {
	EVIOSM_LOC_X,
	EVIOSM_LOC_Y
} evioSMIndices;
#define EVIOSM_SIZE	(EVIOSM_LOC_Y + 1)

#define EVIOST	"Ev_StartCursor"
#define EVIOST_SIZE	1

#define EVIOSETSCREEN	"Ev_SetScreen"
typedef enum {
	EVIOSETSCREEN_TOTALSCREENS,
	EVIOSETSCREEN_INDEX,
	EVIOSETSCREEN_SHMEMSIZE,
	EVIOSETSCREEN_MINX,
	EVIOSETSCREEN_MAXX,
	EVIOSETSCREEN_MINY,
	EVIOSETSCREEN_MAXY
}evioSETSCREENIndices;
#define EVIOSETSCREEN_SIZE	(EVIOSETSCREEN_MAXY + 1)


/* _NXEvGetParameterInt() calls */
#define EVIOEVNUM		"Ev_ButtonEventNums"	/* Mouse driver */
typedef enum {
	EVIOEVNUM_LEFT,
	EVIOEVNUM_RIGHT
} evioEVNUMIndices;
#define EVIOEVNUM_SIZE	(EVIOEVNUM_RIGHT + 1)

#define EVIOSHMEMSIZE	"Ev_ShmemSize"
#define EVIOSHMEMSIZE_SIZE	1

typedef char EVString[64];
typedef char EVParameterName[64];
typedef int EVIntParameter[64];
typedef char EVCharParameter[4096];
typedef unsigned int EVObjectNumber;

#endif /* _DEV_EVIO_ */

#endif	/* DRIVER_PRIVATE */