Home | History | Annotate | Line # | Download | only in wscons
wskbdvar.h revision 1.20 
      1 /* $NetBSD: wskbdvar.h,v 1.20 2022/09/23 19:04:04 riastradh Exp $ */
      2 
      3 /*
      4  * Copyright (c) 1996, 1997 Christopher G. Demetriou.  All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer in the
     13  *    documentation and/or other materials provided with the distribution.
     14  * 3. All advertising materials mentioning features or use of this software
     15  *    must display the following acknowledgement:
     16  *      This product includes software developed by Christopher G. Demetriou
     17  *	for the NetBSD Project.
     18  * 4. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 #ifndef	_DEV_WSCONS_WSKBDVAR_H_
     34 #define	_DEV_WSCONS_WSKBDVAR_H_
     35 
     36 /*
     37  * WSKBD interfaces.
     38  */
     39 #include <dev/wscons/wsksymvar.h>
     40 
     41 /*
     42  * Keyboard access functions (must be provided by all keyboards).
     43  *
     44  * There is a "void *" cookie provided by the keyboard driver associated
     45  * with these functions, which is passed to them when they are invoked.
     46  */
     47 struct wskbd_accessops {
     48 	int	(*enable)(void *, int);
     49 	void    (*set_leds)(void *, int);
     50 	int     (*ioctl)(void *, u_long, void *, int, struct lwp *);
     51 };
     52 
     53 /*
     54  * Keyboard console functions (must be provided by console input keyboards).
     55  *
     56  * There is a "void *" cookie provided by the keyboard driver associated
     57  * with these functions, which is passed to them when they are invoked.
     58  */
     59 struct wskbd_consops {
     60 	void    (*getc)(void *, u_int *, int *);
     61 	void    (*pollc)(void *, int);
     62 	void	(*bell)(void *, u_int, u_int, u_int);
     63 };
     64 
     65 /*
     66  * Attachment information provided by wskbddev devices when attaching
     67  * wskbd units.
     68  */
     69 struct wskbddev_attach_args {
     70 	int	console;				/* is it console? */
     71 	const struct wskbd_mapdata *keymap;
     72 
     73 	const struct wskbd_accessops *accessops;        /* access ops */
     74 	void	*accesscookie;				/* access cookie */
     75 };
     76 
     77 #include "locators.h"
     78 
     79 #define	wskbddevcf_console		cf_loc[WSKBDDEVCF_CONSOLE]	/* spec'd as console? */
     80 #define	WSKBDDEVCF_CONSOLE_UNK		(WSKBDDEVCF_CONSOLE_DEFAULT)
     81 
     82 #define	wskbddevcf_mux		cf_loc[WSKBDDEVCF_MUX]
     83 
     84 /*
     85  * Autoconfiguration helper functions.
     86  */
     87 void	wskbd_cnattach(const struct wskbd_consops *, void *,
     88 			    const struct wskbd_mapdata *);
     89 void	wskbd_cndetach(void);
     90 int	wskbddevprint(void *, const char *);
     91 
     92 /*
     93  * Callbacks from the keyboard driver to the wskbd interface driver.
     94  */
     95 void	wskbd_input(device_t, u_int, int);
     96 /* for WSDISPLAY_COMPAT_RAWKBD */
     97 void	wskbd_rawinput(device_t, u_char *, int);
     98 
     99 /*
    100  * Callbacks for (ACPI) hotkey drivers which generate
    101  * keycodes.
    102  */
    103 struct wskbd_softc;
    104 typedef int (wskbd_hotkey_plugin)(struct wskbd_softc *, void *, u_int, int);
    105 
    106 device_t wskbd_hotkey_register(device_t, void *, wskbd_hotkey_plugin *);
    107 void	 wskbd_hotkey_deregister(device_t);
    108 
    109 /*
    110  * set a translation table for scancodes in event mode
    111  * parameters are a pointer to the table and its length
    112  * pass length zero to turn translation off
    113  */
    114 void	wskbd_set_evtrans(device_t, keysym_t *, int);
    115 
    116 /*
    117  * Console interface.
    118  */
    119 int	wskbd_cngetc(dev_t);
    120 void	wskbd_cnpollc(dev_t, int);
    121 void	wskbd_cnbell(dev_t, u_int, u_int, u_int);
    122 
    123 #endif	/* _DEV_WSCONS_WSKBDVAR_H_ */
    124