Home | History | Annotate | Line # | Download | only in include
      1 /*	$NetBSD: button.h,v 1.1 2006/09/01 21:26:18 uwe Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2003 Wasabi Systems, Inc.
      5  * All rights reserved.
      6  *
      7  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  * 3. All advertising materials mentioning features or use of this software
     18  *    must display the following acknowledgement:
     19  *      This product includes software developed for the NetBSD Project by
     20  *      Wasabi Systems, Inc.
     21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
     22  *    or promote products derived from this software without specific prior
     23  *    written permission.
     24  *
     25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
     26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
     29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     35  * POSSIBILITY OF SUCH DAMAGE.
     36  */
     37 
     38 #ifndef _MACHINE_BUTTON_H_
     39 #define	_MACHINE_BUTTON_H_
     40 
     41 #include <sys/ioccom.h>
     42 
     43 #define	BUTTON_EVENT_PRESSED	0	/* button pressed */
     44 #define	BUTTON_EVENT_RELEASED	1	/* button released */
     45 
     46 #define	BUTTON_STATE_PRESSED	0	/* button pressed */
     47 #define	BUTTON_STATE_RELEASED	1	/* button released */
     48 #define	BUTTON_STATE_UNKNOWN	-1
     49 
     50 /*
     51  * This structure describes the state of a button.  It is used
     52  * by the BUTTON_IOC_GET_SWSTATE ioctl, as well as in button
     53  * event messages.
     54  */
     55 struct button_state {
     56 	char	bs_name[32];		/* button name */
     57 	int32_t	bs_state;		/* state of the switch/event */
     58 };
     59 
     60 /*
     61  * button event messages:
     62  *
     63  * We ensure that a message is always exactly 32 bytes long, so that
     64  * userland doesn't need to issue multiple reads to get a single event.
     65  */
     66 #define	BUTTON_EVENT_MSG_SIZE	32
     67 
     68 #define	BUTTON_EVENT_STATE_CHANGE		0
     69 
     70 typedef struct {
     71 	int32_t		bev_type;	/* button event type */
     72 	union {
     73 		int32_t	_bev_d_space[(BUTTON_EVENT_MSG_SIZE /
     74 				      sizeof(int32_t)) - 1];
     75 
     76 		/*
     77 		 * This field is used for:
     78 		 *
     79 		 *	BUTTON_EVENT_STATE_CHANGE
     80 		 */
     81 		struct button_state _bev_d_event;
     82 	} _bev_data;
     83 } button_event_t;
     84 
     85 #define	bev_event	_bev_data._bev_d_event
     86 
     87 /*
     88  * BUTTON_IOC_GET_TYPE:
     89  *
     90  *	Get the button back-end type.
     91  */
     92 struct button_type {
     93 	char	button_type[32];
     94 };
     95 #define	BUTTON_IOC_GET_TYPE	 _IOR('P', 1, sizeof(struct button_type))
     96 
     97 #endif /* _MACHINE_BUTTON_H_ */
     98