ukbd(4): Sort includes.

No functional change intended.

ukbd(4): Fix ordering in ukbd_cnpollc exit.

This is probably an MP-safety issue waiting to happen, but let's at
least make the wind and unwind sequences mirror images.

ukbd(4): remember how much of attach worked so detach works.

if ukbd_attach() fails it means it has only really done the pmf
setup, nothing else, so avoid trying to remove callouts, child
devices, or console setup, usb task and uhidev operations.

fixes the crash (but not the underlying ukbd doesn't work issue)
seen in PR#57149.

branches: 1.161.4;
remove debug printf

Don't attach Yubikeys as console keyboard.

uhidev(9): Make uhidev state opaque.

This makes the API simpler and clearer and gives us more latitude to
fix bugs in the state management without breaking the ABI.

XXX kernel ABI change to signature of uhidev_get_report_desc and
uhidev_open, and to struct uhidev_attach_arg, requires bump for
uhidev driver modules

uhidev(9): Get the device and interface through attach args.

This way uhidev drivers don't need access to uhidev_softc itself for
it.

ukbd(4): Fix previous change to initial LED flashing.

Without this change the LEDs would get stuck on until the first
keypress. (This also seemed to trigger a crash in heavy load on
bringing aue(4) up and down over and over again while unplugging, but
I'm not sure why and I hope it's not actually related...)

ukbd(4): Avoid races in LED setting on attach.

- Don't reuse sc_delay for LED task -- a keyboard interrupt shortly
after attach might reset sc_delay so that the LEDs never get turned
back off.

- Don't turn the LEDs back off after attach if something else has
already changed them by the time the callout fires.

(And make sure to callout_halt before done this time!)

fix various typos, mainly in comments.

ukbd(4): Wait for callouts and blinking to complete in detach.

This detach routine (and whole driver) has got a lotta other
problems, but let's fix 'em one at a time...

ukbd: blink LEDs asynchronously at boot

Instead of holding up boot by 400ms for each attached ukbd to blink the
keyboard LEDs, turn them on and set a callout to turn them off later.

Merge thorpej-cfargs2.

branches: 1.151.2;
Since there's a bit of code that is conditionally compiled based on
USBVERBOSE, we need to include the opt_usbverbose.h header to get any
possible definition of this macro.

XXX Note that this code will NOT get included in the loadable module
XXX for USBVERBOSE.

branches: 1.150.2;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.149.2;
ukbd: GC some 20 year old code (NFC)

Long ago, code was improved to allow detaching keyboards that were the
console, but the old commen and panic() were #if 0'd instead of
removed.

ukbd: Condition probe-time verbosity on USBVERBOSE

Previously, this driver switched on more verbose messages based on
DIAGNOSTIC. But, the messages weren't about an impossible-to-reach
condition, just extra keys. Change the condition to USBVERBOSE,
documented as serving this purpose.

branches: 1.147.2;
send PMF events for keyboard brightness hotkeys on apple laptops

Summary: Introduce a keyboard event ring buffer for USB console keyboards

For the console keyboard, events must be handled separately from the
interrupt handler, because of the possibility that the user chooses to
drop into DDB by use of the designated key combination. This delayed
handling is tied to the HZ clock through the callout(9) mechanism,
meaning that another keyboard event arriving within 10ms of the
previous one might overwrite its predecessor before it's handled.
This causes dropped events for fast typists - and the situation gets
worse with modern, programmable, keyboards.

This patch introduces a ring buffer in the ukbd_softc data structure,
so that multiple pending events may be safely stored.

revert the 0x% -> %# change for fixed width formats pointed out by uwe.

PR/55068: sc.dying: Fix printf formats:
- no %s/%p for kernel log
- 0x% -> %#
- always %j for kernel log

send PMF events for volume and brightness control keys on Apple keyboards

branches: 1.142.2; 1.142.4;
remove explicit 'extern struct cfdriver <my>_cd;' and use ioconf.h

branches: 1.141.4;
tidy up debugging (make it compile with the 'ALL' kernel)

ukbd_cngetc: poll once for data in the buffer, otherwise return type 0 (no data)

Factor out bus-independant HID code so that it can be shared by USB, bluetooth
and i2c.
dev/usb/ukbdmap.c is renamed to dev/hid/hidkbdmap.c
dev/usb/hid.[ch] moved to dev/hid/
usage pages moved from dev/usb/usbhid.h moved to dev/hid/hid.h,
and updated with OpenBSD entries.
bus-independant code moved from dev/usb/ums.c to dev/hid/hidms.c
(the same should be done for keyboard and touchpad drivers)

Needed for the upcoming HID over I2C support, proposed on tech-kern@
on Dec, 1.

Support more varieties of USB keyboard reports.

The previous code asssumed reports would closely match the Bootstrap
Keyboard Protocol. This is no longer always the case, particularly
with higher-end keyboards.

Fix memory leak in report parsing error paths.

branches: 1.136.6;
don't memcpy overlapping buffers, use memmove.
this is undefined behaviour.
CID 1299069

kassert that we aren't overflowing the array.

this assert isn't expected to trigger due to current parameters used, but
to be sure, check.

branches: 1.134.2;
Sort opt_* #includes

branches: 1.133.2;
Make GDIUM_KEYBOARD_HACK compile

Pull in opt_usb.h in _KERNEL_OPT case for various *_DEBUG options.
Makes various driver-specific debugging options work again.

XXX more to fix in dev/usb

Merge nick-nhusb

- API / infrastructure changes to support memory management changes.
- Memory management improvements and bug fixes.
- HCDs should now be MP safe
- conversion to KERNHIST based debug
- FS/LS isoc support on ehci(4).
- conversion to kmem(9)
- Some USB 3 support - mostly from Takahiro HAYASHI (t-hash).
- interrupt transfers now get proper DMA operations
- general bug fixes
- kern/48308
- uhub status notification improvements
- umass(4) probe fix (applied to HEAD already)
- ohci(4) short transfer fix

properly protect uhid's sc_q member with sc_lock. should fix PR#49728.
while here, remove D_MPSAFE from uhid* and all uhid users, as it really
needs all the callers to be safe and they're not.

XXX: pullup-7

branches: 1.129.4; 1.129.6;
Remove usbd_do_request_async. It's callback was calling usbd_free_xfer
from softint context.

Adjust callers appropriately

- usbd_clear_endpoint_stall_async is already triggered via a
usb_task, so simply call usbd_do_request.

- uhidev_set_report_async had one caller in ukbd_set_leds.
Convert this usage to use usb_task as well.

Discussed with mrg@

ifdef variable like their use

Missing AB_QUIET newlines.

branches: 1.126.4; 1.126.6;
Whitespace

- need opt_usb.h if depending on USB_DEBUG
- remove trailing whitespace
- add missing KERNEL_RCSID

branches: 1.124.2;
merge the jmcneill-usbmp branch. many thanks to jared for the
initial work, and every one else who has tested things for me.
this is largely my fault at this point :-)

the main changes are something like:

- usbd_bus_methods{} gains a get_lock() to enable the
host controller to provide a lock for the USB code.
if the lock isn't provided, old-style protection is
(partially) applied.

- ehci/ohci/uhci have been converted to the new
interfaces, including mutex/cv/etc conversion.

- usbdivar.h contains a discussion about locking and
what locks are held for which method calls. more
to come for usbdi(9) here.

- audio drivers (uaudio, umidi, auvitek) have been
properly SMPified now that USB is ready.

- scsi drivers have been modified to take the kernel
lock explicitly before calling into scsi code.

- usb pipes are associated with a lock, that is the
same as the controller lock. (this could be split
up further in the future.)

- several usbfoo_locked() or usbfoo_unlocked()
functions have been added to the usbdi(9) to
enable functionality with or without the USB
lock (per controller) already being held.

the TODO.usbmp file has specific details on what is left to
do, including what device-specific changes should be done now
that the whole framework is ready.

Revert previous commit, as it really is wrong to grow ukbd_trtab to an array
of 16-bit values. While at it, set the correct value for the Sleep button.

Likewise, keep forwarding the keys specific to the Sun Type 7 USB keyboard as
raw input (currently required for X), but making sure to use unassigned and
valid values this time.

Tested with modular-xorg-server 1.6.5nb11 and xf86-input-keyboard 1.3.2nb3.

Implemented extra keys as found on Sun Type 7 USB keyboards, and
according to the documentation mentioned above in this file.

"works here" macallan@, myself

Also lookup and be able to lit the LED for the Compose key. Seems to
require additional modifications to function properly in X though.

No objection on current-users@

Convert keycodes 0x7f, 0x80 and 0x81 to PMF events VOLUME_TOGGLE,
VOLUME_UP and VOLUME_DOWN as observed on my Sun Type 7 USB keyboard, and
according to the documentation mentioned above.

"works here" macallan@ and myself

Indent the trtab_gdium_fn array like surrounding variables.

No objection on current-users@

Fixed a potential out-of-bounds array access when translating keycodes
for the gdium keyboard.

Reviewed by macallan@

minor cleanups from usbmp:
- move usbd_delay_ms() into usbdivar.h in the usb_subr.c section
- minor rcsid fixes
- copyright maintenence

remove any remnants of freebsd/openbsd code.

branches: 1.115.2;
Revert previous due to active usbmp branch(es).

Adjust-away inconsistent and trailing whitespace.

branches: 1.113.4;
only build gdium Fn support with options GDIUM_KEYBOARD_HACK

branches: 1.112.2;
support PMF events as target type in scancode translation tables

support Gdium's Fn key
translation table from OpenBSD

Cap h.loc.count at MAXKEYCODE instead of bailing out. This lets some obscure/
roque keyboards attach.

From loganaden@devio.us (Loganaden Velvindron), thanks!

Support for Apple notebook keyboards, which have a few quirks.
1. On ISO-keyboard the keycodes for the key left of '1' and right of Shift
are swapped.
2. Find the Apple FN key in the report descriptor and do the translations
needed, before passing the keycodes to wscons.
3. Those keyboards only have the left Alt key. AltGr is missing. So it is
emulated when holding down FN together with Alt.

Stop using the compatibility macros USB_ATTACH(), USB_DETACH(),
USB_MATCH(), et cetera. These files produce the same assembly
(according to objdump -d) before and after the change

branches: 1.107.2;
Tweak comment about keyboard mapping.

branches: 1.106.2;
_KERNEL_POT

Simplify activation hooks. (sc_dying must die!)

Fix WSKBD_RAW mode ukbd -> pckbd translation for Pause/Break and
Print Screen/Sys Req keys so xf86-input-keyboard can figure out
what we want.

Additionally, fix dead URL, and add a note that this emulation
is not completely identical to a real pckbd.

These don't need <sys/tty.h>.

branches: 1.102.2;
make this compile

branches: 1.101.2; 1.101.4; 1.101.10;
register with pmf

branches: 1.100.4;
Split device_t and softc for all USB device drivers, and related cosmetic
changes.

Matthias Drochner kindly reviewed this patch, and tested ums, ubt, uaudio
and ral. I tested umass myself.

branches: 1.99.2;
Remove clause 3 and 4 from TNF licenses

branches: 1.98.2; 1.98.4;
use aprint_*_dev and device_xname

branches: 1.97.6;
Use device_t and its accessor functions.

Register _childdetached methods with drivers that attach children.
Wait to set child references to NULL there, instead of doing that
in the detach method.

Replace many uses of USB_DECLARE_DRIVER() with CFATTACH_DECL2().

Add support for function keys F16 to F19 as present on e.g. the new
Apple aluminum keyboard.

Patch contributed by Michael Piotrowski in PR kern/37788, reviewed
by Matthias Drochner.

branches: 1.95.16; 1.95.22;
Kill caddr_t; there will be some MI fallout, but it will be fixed shortly.

branches: 1.94.2; 1.94.4; 1.94.8; 1.94.10;
__unused removal on arguments; approved by core.

- sprinkle __unused on function decls.
- fix a couple of unused bugs
- no more -Wno-unused for i386

branches: 1.92.2; 1.92.4;
add missing initializer

Use device_unit().

branches: 1.90.4; 1.90.6; 1.90.8; 1.90.10; 1.90.12;
merge ktrace-lwp.

branches: 1.89.2;
Provide a header for UKBD_LAYOUT. It makes more sense, and it avoids
quoting issues during the build process.

Reported and checked by spz@.

Fix ifdef botch in previous revision:

The `Static' forward declaration of ukbd_rawrepeat was inside #ifdef
UKBD_REPEAT but not #ifdef DISPLAY_COMPAT_RAWCKBD. The definition and
all other references are inside both #ifdefs. The `static' function
declaration with no definition failed GCC warnings.

Pass GCC warnings by wrapping the declaration with a check that both
CPP tokens are defined.

Don't emulate auto repeat in the keyboard driver, the wskbd driver does that.
Auto repeat emulation can be turned on by defining UKBD_REPEAT, but this
should never be necessary.

If UKBD_LAYOUT isn't defined, but PCKBD_LAYOUT is, use the latter as the
default layout. Fixes half of kern/28668.

branches: 1.85.2; 1.85.8; 1.85.16;
Update URLs for the HID spec.

(Committed at 36000 feet above the Atlantic on board LH418 using
a broadband satellite connection.)

Make sure we are at splusb() while polling.

Remove breaks after returns, unreachable returns and returns after
returns(!).

Get rid of trailing white space.

branches: 1.81.4;
Convert ioctl code to use EPASSTHROUGH instead of -1 or ENOTTY for
indicating an unhandled "command". ERESTART is -1, which can lead to
confusion. ERESTART has been moved to -3 and EPASSTHROUGH has been
placed at -4. No ioctl code should now return -1 anywhere. The
ioctl() system call is now properly restartable.

Make a typedef for struct proc to make portingeasier.

A little more debug.

Fix typo.

Remove garbage.

Add some missing scan code translations. Docs from Microsoft via Perry Metzger.

Introduce an extra driver level for HID devices, uhidev. This uhidev driver
attaches to the hub, and HID drivers (ums, ukbd, and uhid) attach to
uhidev. The reason for this change is that some HID devices report multiple
components (like a keyboard and a mouse) using the same interface, but with
different report identifiers. The report identifier can be specified with
a locator for the HID drivers.
Furthermore, change the ukbd driver to handle other formats than the boot
protocol.

use #ifdef DDB (for consistency with the rest of the kernel)

usbd_interface2device_handle() cannot fail.

add RCSIDs

Add a workaround for broken ports (e.g. macppc) that do not call
cnpollc before cngetc in DDB. DDB now works with USB console on Macs.

Don't frob the LEDs if nothing changes.

Use the usb callout macros.

If we are the console and we have DDB then events must not be delivered
from the interrupt routine since this will enter the USB interrupt
processing recursively during polling.
Now ukbd can be used as console keyboard for DDB!

Make sure interrupt pipe is closed when detaching console keyboard.

branches: 1.67.2;
Only clear the endpoint on stall (from FreeBSD).

branches: 1.66.2; 1.66.4;
Allow a UKBD_LAYOUT option to determine the default keyboard layout.
(From OpenBSD.)

branches: 1.65.2;
make some more constant arrays 'const'

Make sure driver attach/detach events are generated in a consistent manner.

Update many URLs.

Implement handling of the UQ_SPUR_BUT_UP quirk. Some keyboards sometimes
generate a key up quickly followed by a key down for the same key, so we
take care of that.
(Finally I can type again without going nuts. :)

Add two keys to the raw mapping for German keyboards.
From Matthias Kretschmer <McCratch@gmx.net>, fixes PR 10850.

Bring the coding style into the 80s, i.e., get rid of __P and use
ANSI prototypes and declarations.

branches: 1.59.2;
Change my email address.

Change (almost) all static to Static. The symbol `Static' can then be defined
to `' or `static' depending on if you want to debug or not.

New callout mechanism with two major improvements over the old
timeout()/untimeout() API:
- Clients supply callout handle storage, thus eliminating problems of
resource allocation.
- Insertion and removal of callouts is constant time, important as
this facility is used quite a lot in the kernel.

The old timeout()/untimeout() API has been removed from the kernel.

Distinguish between device and interface classes.
(I finally found a document that said that they were different.)

Generate usb events on attach and detach.

Add an argument to usbd_open_pipe_intr() to specify the polling interval
for an interrupt pipe in case we don't what what the descriptor suggests.

Add a DPRINTF on keyboard errors.

Let usbd_set_polling() work on a usbd_device_handle instead of
a usbd_interface_handle.

Cosmetics and a couple of diagnostic messages.

Done something half sensible if a USB console keyboard is unplugged instead
of panic()ing.
XXX Untested. I will test it the next time I can borrow an iMac.

Cosmetic changes.

Hide function definition within ifdef's is becomes active in.

A number of stylistic changes to increase readability (many suggested
by Nick Hibma):
use NULL not 0
declare all local definitions static
rename s/usbd_request/usbd_xfer/ s/reqh/xfer/
rename s/r/err/
use implicit test for no err
KNF

branches: 1.46.2; 1.46.4;
Merge in a large batch of changes from Nick Hibma <hibma@skylink.it> so
the USB stack compiles on FreeBSD again.

Add an event mechanism so that a userland process can watch devices come
and go.

branches: 1.44.2;
Dot't forget to deactivate subdevices.

Change the way the `struct device' base part of all driver softc are
declared and accessed to make it more portable. Idea from Nick Hibma, FreeBSD.
No functional changes.

Change the way the direction is extracted from the endpoint descriptor.
No functional changes to the drivers. From Nick Hibma, FreeBSD.

Change some 'struct device' to 'bdevice'. From FreeBSD.

Make sure to mark the device as dying already in the (de)activate routine.
This avoids access to it before the detach routine has blown it away.

Some changes from FreeBSD (no functional differences).

More DIAGNOSTIC messages.

Totally redo the way device detach is done. It now uses a kernel event
thread and the config detach method.
Squish a number of space leaks on detach.

Remove unneeded #include.

Get rid of a bunch of code that was part of an old USBDI proposal, but that
is unused in our USB stack.

Once upon a time, when I started writing the USB stack for NetBSD, there
was an effort to make a standard for how USB device drivers should interact
with the rest of the USB stack. This effort had contributors from just
about all Un*x camps (but not Micro$oft :). I based my design on one of their
early proposals since I thought it would be a good idea if we could all
share device drivers with a minimum effort. Shortly after I started my work
all the free Un*x people were thrown out of the USBDI work since we did not
pay the USB membership fee. Well, some time has passed now and the work of
the standardization group is almost public again. But alas, the new standard
has grown to be a monster! I do not want to have this as the basis for the
*BSD USB stack; it is far too complicated.
So, since we are not even close to being compilant with the standard, I've
thrown out some old baggage.

If we're the console keyboard, automatically enable the keyboard.

Should fix part of console keyboard problems on macppc. The usb keyboard will
now work on boot! Doesn't fix problems with keyboard freaking out when
changing LED state.

Thanks to Mattias & Lennart & Tsubai for input on resolving this problem.

Add more debug.

Fix debug printf.

Rework the way ukbd attaches itself as the console (again). We now allow
the code to pick the first USB keyboard instance as the console, ignoring
which USB controller it's on. Should eventually allow detaching of the
console keyboard.

From Jason Thorpe <thorpej@nas.nasa.gov>

Call ws routines at spltty() from interrupt routines.

Add a way for machine-dependent code to tell a USB controller that it
has the console input device. The USB keyboard driver uses this to
attach the first USB keyboard instance as the console keyboard.

Unfortunately, this must still be deferred to autoconfiguration time,
but there's not much we can do about that right now.

branches: 1.28.2;
Fix transpostion in translation table for XT scan codes.

Make sure to check the modifier map for the windows keys.

Fix buglets in translation to raw scancodes.

Update/add URLs to relevant USB specs.

Move a declaration.

Use a special map for USB key code translation instead of first translating
to an XT scancode and then to the wscons code.
XXX The XT translation is still available in "raw" mode.

there is no "cnattach" member in "struct wskbd_accessops" (yet?)

Various little fixes from the FreeBSD version.

Implement autorepeat in raw keyboard mode.

Implement raw keyboard mode for X.

Add some #if 0 code for keyboard console attachment.

Cosmetics.

Merge changes to make the USB stack work with FreeBSD. The original
diffs from Nick Hibma <n_hibma@freebsd.org>, but with substantial
changes from me.
XXX Not tested on FreeBSD yet.

Take care of some lines > 80 chars.

Improvement to the ugen driver.
Better error checking.
Some code rearrengment.

Even shorter printfs at attach.

Avoid wrapping lines in attach printfs.

Make the copyright header conform to the NetBSD template.

Adapt to keymap table format change.

Use wskbd enable function.

Adapt to wskbd interface changes; add dummy enable/disable function.

Make sure to abort the interrupt pipe on disconnect of a mouse or keyboard.
Improve some error messages.

Switch from a global flag to tell if the host controller should use
polling to a local one for each controller.

Complete the scancode conversion table.
Tell the keyboard not to send idle reports.

Add functions to execute asynchronous requests and use these from
interrupt context.
[I had some feline debugging help here. I noticed that every time Kem,
our kitty, jumped onto the USB keyboard the machine crashed.]

A first stab att supporting console access with a USB keyboard.

Add wscons attachments for USB keyboard.

Add USB support. Supported so far:
* UHCI and OHCI host controllers on PCI
* Hubs
* HID devices withe special drivers for mouse and keyboard
* Printers

ukbd(4): remember how much of attach worked so detach works.

if ukbd_attach() fails it means it has only really done the pmf
setup, nothing else, so avoid trying to remove callouts, child
devices, or console setup, usb task and uhidev operations.

fixes the crash (but not the underlying ukbd doesn't work issue)
seen in PR#57149.

remove debug printf

Don't attach Yubikeys as console keyboard.

uhidev(9): Make uhidev state opaque.

This makes the API simpler and clearer and gives us more latitude to
fix bugs in the state management without breaking the ABI.

XXX kernel ABI change to signature of uhidev_get_report_desc and
uhidev_open, and to struct uhidev_attach_arg, requires bump for
uhidev driver modules

uhidev(9): Get the device and interface through attach args.

This way uhidev drivers don't need access to uhidev_softc itself for
it.

ukbd(4): Fix previous change to initial LED flashing.

Without this change the LEDs would get stuck on until the first
keypress. (This also seemed to trigger a crash in heavy load on
bringing aue(4) up and down over and over again while unplugging, but
I'm not sure why and I hope it's not actually related...)

ukbd(4): Avoid races in LED setting on attach.

- Don't reuse sc_delay for LED task -- a keyboard interrupt shortly
after attach might reset sc_delay so that the LEDs never get turned
back off.

- Don't turn the LEDs back off after attach if something else has
already changed them by the time the callout fires.

(And make sure to callout_halt before done this time!)

fix various typos, mainly in comments.

ukbd(4): Wait for callouts and blinking to complete in detach.

This detach routine (and whole driver) has got a lotta other
problems, but let's fix 'em one at a time...

ukbd: blink LEDs asynchronously at boot

Instead of holding up boot by 400ms for each attached ukbd to blink the
keyboard LEDs, turn them on and set a callout to turn them off later.

Merge thorpej-cfargs2.

branches: 1.151.2;
Since there's a bit of code that is conditionally compiled based on
USBVERBOSE, we need to include the opt_usbverbose.h header to get any
possible definition of this macro.

XXX Note that this code will NOT get included in the loadable module
XXX for USBVERBOSE.

branches: 1.150.2;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.149.2;
ukbd: GC some 20 year old code (NFC)

Long ago, code was improved to allow detaching keyboards that were the
console, but the old commen and panic() were #if 0'd instead of
removed.

ukbd: Condition probe-time verbosity on USBVERBOSE

Previously, this driver switched on more verbose messages based on
DIAGNOSTIC. But, the messages weren't about an impossible-to-reach
condition, just extra keys. Change the condition to USBVERBOSE,
documented as serving this purpose.

branches: 1.147.2;
send PMF events for keyboard brightness hotkeys on apple laptops

Summary: Introduce a keyboard event ring buffer for USB console keyboards

For the console keyboard, events must be handled separately from the
interrupt handler, because of the possibility that the user chooses to
drop into DDB by use of the designated key combination. This delayed
handling is tied to the HZ clock through the callout(9) mechanism,
meaning that another keyboard event arriving within 10ms of the
previous one might overwrite its predecessor before it's handled.
This causes dropped events for fast typists - and the situation gets
worse with modern, programmable, keyboards.

This patch introduces a ring buffer in the ukbd_softc data structure,
so that multiple pending events may be safely stored.

revert the 0x% -> %# change for fixed width formats pointed out by uwe.

PR/55068: sc.dying: Fix printf formats:
- no %s/%p for kernel log
- 0x% -> %#
- always %j for kernel log

send PMF events for volume and brightness control keys on Apple keyboards

branches: 1.142.2; 1.142.4;
remove explicit 'extern struct cfdriver <my>_cd;' and use ioconf.h

branches: 1.141.4;
tidy up debugging (make it compile with the 'ALL' kernel)

ukbd_cngetc: poll once for data in the buffer, otherwise return type 0 (no data)

Factor out bus-independant HID code so that it can be shared by USB, bluetooth
and i2c.
dev/usb/ukbdmap.c is renamed to dev/hid/hidkbdmap.c
dev/usb/hid.[ch] moved to dev/hid/
usage pages moved from dev/usb/usbhid.h moved to dev/hid/hid.h,
and updated with OpenBSD entries.
bus-independant code moved from dev/usb/ums.c to dev/hid/hidms.c
(the same should be done for keyboard and touchpad drivers)

Needed for the upcoming HID over I2C support, proposed on tech-kern@
on Dec, 1.

Support more varieties of USB keyboard reports.

The previous code asssumed reports would closely match the Bootstrap
Keyboard Protocol. This is no longer always the case, particularly
with higher-end keyboards.

Fix memory leak in report parsing error paths.

branches: 1.136.6;
don't memcpy overlapping buffers, use memmove.
this is undefined behaviour.
CID 1299069

kassert that we aren't overflowing the array.

this assert isn't expected to trigger due to current parameters used, but
to be sure, check.

branches: 1.134.2;
Sort opt_* #includes

branches: 1.133.2;
Make GDIUM_KEYBOARD_HACK compile

Pull in opt_usb.h in _KERNEL_OPT case for various *_DEBUG options.
Makes various driver-specific debugging options work again.

XXX more to fix in dev/usb

Merge nick-nhusb

- API / infrastructure changes to support memory management changes.
- Memory management improvements and bug fixes.
- HCDs should now be MP safe
- conversion to KERNHIST based debug
- FS/LS isoc support on ehci(4).
- conversion to kmem(9)
- Some USB 3 support - mostly from Takahiro HAYASHI (t-hash).
- interrupt transfers now get proper DMA operations
- general bug fixes
- kern/48308
- uhub status notification improvements
- umass(4) probe fix (applied to HEAD already)
- ohci(4) short transfer fix

properly protect uhid's sc_q member with sc_lock. should fix PR#49728.
while here, remove D_MPSAFE from uhid* and all uhid users, as it really
needs all the callers to be safe and they're not.

XXX: pullup-7

branches: 1.129.4; 1.129.6;
Remove usbd_do_request_async. It's callback was calling usbd_free_xfer
from softint context.

Adjust callers appropriately

- usbd_clear_endpoint_stall_async is already triggered via a
usb_task, so simply call usbd_do_request.

- uhidev_set_report_async had one caller in ukbd_set_leds.
Convert this usage to use usb_task as well.

Discussed with mrg@

ifdef variable like their use

Missing AB_QUIET newlines.

branches: 1.126.4; 1.126.6;
Whitespace

- need opt_usb.h if depending on USB_DEBUG
- remove trailing whitespace
- add missing KERNEL_RCSID

branches: 1.124.2;
merge the jmcneill-usbmp branch. many thanks to jared for the
initial work, and every one else who has tested things for me.
this is largely my fault at this point :-)

the main changes are something like:

- usbd_bus_methods{} gains a get_lock() to enable the
host controller to provide a lock for the USB code.
if the lock isn't provided, old-style protection is
(partially) applied.

- ehci/ohci/uhci have been converted to the new
interfaces, including mutex/cv/etc conversion.

- usbdivar.h contains a discussion about locking and
what locks are held for which method calls. more
to come for usbdi(9) here.

- audio drivers (uaudio, umidi, auvitek) have been
properly SMPified now that USB is ready.

- scsi drivers have been modified to take the kernel
lock explicitly before calling into scsi code.

- usb pipes are associated with a lock, that is the
same as the controller lock. (this could be split
up further in the future.)

- several usbfoo_locked() or usbfoo_unlocked()
functions have been added to the usbdi(9) to
enable functionality with or without the USB
lock (per controller) already being held.

the TODO.usbmp file has specific details on what is left to
do, including what device-specific changes should be done now
that the whole framework is ready.

Revert previous commit, as it really is wrong to grow ukbd_trtab to an array
of 16-bit values. While at it, set the correct value for the Sleep button.

Likewise, keep forwarding the keys specific to the Sun Type 7 USB keyboard as
raw input (currently required for X), but making sure to use unassigned and
valid values this time.

Tested with modular-xorg-server 1.6.5nb11 and xf86-input-keyboard 1.3.2nb3.

Implemented extra keys as found on Sun Type 7 USB keyboards, and
according to the documentation mentioned above in this file.

"works here" macallan@, myself

Also lookup and be able to lit the LED for the Compose key. Seems to
require additional modifications to function properly in X though.

No objection on current-users@

Convert keycodes 0x7f, 0x80 and 0x81 to PMF events VOLUME_TOGGLE,
VOLUME_UP and VOLUME_DOWN as observed on my Sun Type 7 USB keyboard, and
according to the documentation mentioned above.

"works here" macallan@ and myself

Indent the trtab_gdium_fn array like surrounding variables.

No objection on current-users@

Fixed a potential out-of-bounds array access when translating keycodes
for the gdium keyboard.

Reviewed by macallan@

minor cleanups from usbmp:
- move usbd_delay_ms() into usbdivar.h in the usb_subr.c section
- minor rcsid fixes
- copyright maintenence

remove any remnants of freebsd/openbsd code.

branches: 1.115.2;
Revert previous due to active usbmp branch(es).

Adjust-away inconsistent and trailing whitespace.

branches: 1.113.4;
only build gdium Fn support with options GDIUM_KEYBOARD_HACK

branches: 1.112.2;
support PMF events as target type in scancode translation tables

support Gdium's Fn key
translation table from OpenBSD

Cap h.loc.count at MAXKEYCODE instead of bailing out. This lets some obscure/
roque keyboards attach.

From loganaden@devio.us (Loganaden Velvindron), thanks!

Support for Apple notebook keyboards, which have a few quirks.
1. On ISO-keyboard the keycodes for the key left of '1' and right of Shift
are swapped.
2. Find the Apple FN key in the report descriptor and do the translations
needed, before passing the keycodes to wscons.
3. Those keyboards only have the left Alt key. AltGr is missing. So it is
emulated when holding down FN together with Alt.

Stop using the compatibility macros USB_ATTACH(), USB_DETACH(),
USB_MATCH(), et cetera. These files produce the same assembly
(according to objdump -d) before and after the change

branches: 1.107.2;
Tweak comment about keyboard mapping.

branches: 1.106.2;
_KERNEL_POT

Simplify activation hooks. (sc_dying must die!)

Fix WSKBD_RAW mode ukbd -> pckbd translation for Pause/Break and
Print Screen/Sys Req keys so xf86-input-keyboard can figure out
what we want.

Additionally, fix dead URL, and add a note that this emulation
is not completely identical to a real pckbd.

These don't need <sys/tty.h>.

branches: 1.102.2;
make this compile

branches: 1.101.2; 1.101.4; 1.101.10;
register with pmf

branches: 1.100.4;
Split device_t and softc for all USB device drivers, and related cosmetic
changes.

Matthias Drochner kindly reviewed this patch, and tested ums, ubt, uaudio
and ral. I tested umass myself.

branches: 1.99.2;
Remove clause 3 and 4 from TNF licenses

branches: 1.98.2; 1.98.4;
use aprint_*_dev and device_xname

branches: 1.97.6;
Use device_t and its accessor functions.

Register _childdetached methods with drivers that attach children.
Wait to set child references to NULL there, instead of doing that
in the detach method.

Replace many uses of USB_DECLARE_DRIVER() with CFATTACH_DECL2().

Add support for function keys F16 to F19 as present on e.g. the new
Apple aluminum keyboard.

Patch contributed by Michael Piotrowski in PR kern/37788, reviewed
by Matthias Drochner.

branches: 1.95.16; 1.95.22;
Kill caddr_t; there will be some MI fallout, but it will be fixed shortly.

branches: 1.94.2; 1.94.4; 1.94.8; 1.94.10;
__unused removal on arguments; approved by core.

- sprinkle __unused on function decls.
- fix a couple of unused bugs
- no more -Wno-unused for i386

branches: 1.92.2; 1.92.4;
add missing initializer

Use device_unit().

branches: 1.90.4; 1.90.6; 1.90.8; 1.90.10; 1.90.12;
merge ktrace-lwp.

branches: 1.89.2;
Provide a header for UKBD_LAYOUT. It makes more sense, and it avoids
quoting issues during the build process.

Reported and checked by spz@.

Fix ifdef botch in previous revision:

The `Static' forward declaration of ukbd_rawrepeat was inside #ifdef
UKBD_REPEAT but not #ifdef DISPLAY_COMPAT_RAWCKBD. The definition and
all other references are inside both #ifdefs. The `static' function
declaration with no definition failed GCC warnings.

Pass GCC warnings by wrapping the declaration with a check that both
CPP tokens are defined.

Don't emulate auto repeat in the keyboard driver, the wskbd driver does that.
Auto repeat emulation can be turned on by defining UKBD_REPEAT, but this
should never be necessary.

If UKBD_LAYOUT isn't defined, but PCKBD_LAYOUT is, use the latter as the
default layout. Fixes half of kern/28668.

branches: 1.85.2; 1.85.8; 1.85.16;
Update URLs for the HID spec.

(Committed at 36000 feet above the Atlantic on board LH418 using
a broadband satellite connection.)

Make sure we are at splusb() while polling.

Remove breaks after returns, unreachable returns and returns after
returns(!).

Get rid of trailing white space.

branches: 1.81.4;
Convert ioctl code to use EPASSTHROUGH instead of -1 or ENOTTY for
indicating an unhandled "command". ERESTART is -1, which can lead to
confusion. ERESTART has been moved to -3 and EPASSTHROUGH has been
placed at -4. No ioctl code should now return -1 anywhere. The
ioctl() system call is now properly restartable.

Make a typedef for struct proc to make portingeasier.

A little more debug.

Fix typo.

Remove garbage.

Add some missing scan code translations. Docs from Microsoft via Perry Metzger.

Introduce an extra driver level for HID devices, uhidev. This uhidev driver
attaches to the hub, and HID drivers (ums, ukbd, and uhid) attach to
uhidev. The reason for this change is that some HID devices report multiple
components (like a keyboard and a mouse) using the same interface, but with
different report identifiers. The report identifier can be specified with
a locator for the HID drivers.
Furthermore, change the ukbd driver to handle other formats than the boot
protocol.

use #ifdef DDB (for consistency with the rest of the kernel)

usbd_interface2device_handle() cannot fail.

add RCSIDs

Add a workaround for broken ports (e.g. macppc) that do not call
cnpollc before cngetc in DDB. DDB now works with USB console on Macs.

Don't frob the LEDs if nothing changes.

Use the usb callout macros.

If we are the console and we have DDB then events must not be delivered
from the interrupt routine since this will enter the USB interrupt
processing recursively during polling.
Now ukbd can be used as console keyboard for DDB!

Make sure interrupt pipe is closed when detaching console keyboard.

branches: 1.67.2;
Only clear the endpoint on stall (from FreeBSD).

branches: 1.66.2; 1.66.4;
Allow a UKBD_LAYOUT option to determine the default keyboard layout.
(From OpenBSD.)

branches: 1.65.2;
make some more constant arrays 'const'

Make sure driver attach/detach events are generated in a consistent manner.

Update many URLs.

Implement handling of the UQ_SPUR_BUT_UP quirk. Some keyboards sometimes
generate a key up quickly followed by a key down for the same key, so we
take care of that.
(Finally I can type again without going nuts. :)

Add two keys to the raw mapping for German keyboards.
From Matthias Kretschmer <McCratch@gmx.net>, fixes PR 10850.

Bring the coding style into the 80s, i.e., get rid of __P and use
ANSI prototypes and declarations.

branches: 1.59.2;
Change my email address.

Change (almost) all static to Static. The symbol `Static' can then be defined
to `' or `static' depending on if you want to debug or not.

New callout mechanism with two major improvements over the old
timeout()/untimeout() API:
- Clients supply callout handle storage, thus eliminating problems of
resource allocation.
- Insertion and removal of callouts is constant time, important as
this facility is used quite a lot in the kernel.

The old timeout()/untimeout() API has been removed from the kernel.

Distinguish between device and interface classes.
(I finally found a document that said that they were different.)

Generate usb events on attach and detach.

Add an argument to usbd_open_pipe_intr() to specify the polling interval
for an interrupt pipe in case we don't what what the descriptor suggests.

Add a DPRINTF on keyboard errors.

Let usbd_set_polling() work on a usbd_device_handle instead of
a usbd_interface_handle.

Cosmetics and a couple of diagnostic messages.

Done something half sensible if a USB console keyboard is unplugged instead
of panic()ing.
XXX Untested. I will test it the next time I can borrow an iMac.

Cosmetic changes.

Hide function definition within ifdef's is becomes active in.

A number of stylistic changes to increase readability (many suggested
by Nick Hibma):
use NULL not 0
declare all local definitions static
rename s/usbd_request/usbd_xfer/ s/reqh/xfer/
rename s/r/err/
use implicit test for no err
KNF

branches: 1.46.2; 1.46.4;
Merge in a large batch of changes from Nick Hibma <hibma@skylink.it> so
the USB stack compiles on FreeBSD again.

Add an event mechanism so that a userland process can watch devices come
and go.

branches: 1.44.2;
Dot't forget to deactivate subdevices.

Change the way the `struct device' base part of all driver softc are
declared and accessed to make it more portable. Idea from Nick Hibma, FreeBSD.
No functional changes.

Change the way the direction is extracted from the endpoint descriptor.
No functional changes to the drivers. From Nick Hibma, FreeBSD.

Change some 'struct device' to 'bdevice'. From FreeBSD.

Make sure to mark the device as dying already in the (de)activate routine.
This avoids access to it before the detach routine has blown it away.

Some changes from FreeBSD (no functional differences).

More DIAGNOSTIC messages.

Totally redo the way device detach is done. It now uses a kernel event
thread and the config detach method.
Squish a number of space leaks on detach.

Remove unneeded #include.

Get rid of a bunch of code that was part of an old USBDI proposal, but that
is unused in our USB stack.

Once upon a time, when I started writing the USB stack for NetBSD, there
was an effort to make a standard for how USB device drivers should interact
with the rest of the USB stack. This effort had contributors from just
about all Un*x camps (but not Micro$oft :). I based my design on one of their
early proposals since I thought it would be a good idea if we could all
share device drivers with a minimum effort. Shortly after I started my work
all the free Un*x people were thrown out of the USBDI work since we did not
pay the USB membership fee. Well, some time has passed now and the work of
the standardization group is almost public again. But alas, the new standard
has grown to be a monster! I do not want to have this as the basis for the
*BSD USB stack; it is far too complicated.
So, since we are not even close to being compilant with the standard, I've
thrown out some old baggage.

If we're the console keyboard, automatically enable the keyboard.

Should fix part of console keyboard problems on macppc. The usb keyboard will
now work on boot! Doesn't fix problems with keyboard freaking out when
changing LED state.

Thanks to Mattias & Lennart & Tsubai for input on resolving this problem.

Add more debug.

Fix debug printf.

Rework the way ukbd attaches itself as the console (again). We now allow
the code to pick the first USB keyboard instance as the console, ignoring
which USB controller it's on. Should eventually allow detaching of the
console keyboard.

From Jason Thorpe <thorpej@nas.nasa.gov>

Call ws routines at spltty() from interrupt routines.

Add a way for machine-dependent code to tell a USB controller that it
has the console input device. The USB keyboard driver uses this to
attach the first USB keyboard instance as the console keyboard.

Unfortunately, this must still be deferred to autoconfiguration time,
but there's not much we can do about that right now.

branches: 1.28.2;
Fix transpostion in translation table for XT scan codes.

Make sure to check the modifier map for the windows keys.

Fix buglets in translation to raw scancodes.

Update/add URLs to relevant USB specs.

Move a declaration.

Use a special map for USB key code translation instead of first translating
to an XT scancode and then to the wscons code.
XXX The XT translation is still available in "raw" mode.

there is no "cnattach" member in "struct wskbd_accessops" (yet?)

Various little fixes from the FreeBSD version.

Implement autorepeat in raw keyboard mode.

Implement raw keyboard mode for X.

Add some #if 0 code for keyboard console attachment.

Cosmetics.

Merge changes to make the USB stack work with FreeBSD. The original
diffs from Nick Hibma <n_hibma@freebsd.org>, but with substantial
changes from me.
XXX Not tested on FreeBSD yet.

Take care of some lines > 80 chars.

Improvement to the ugen driver.
Better error checking.
Some code rearrengment.

Even shorter printfs at attach.

Avoid wrapping lines in attach printfs.

Make the copyright header conform to the NetBSD template.

Adapt to keymap table format change.

Use wskbd enable function.

Adapt to wskbd interface changes; add dummy enable/disable function.

Make sure to abort the interrupt pipe on disconnect of a mouse or keyboard.
Improve some error messages.

Switch from a global flag to tell if the host controller should use
polling to a local one for each controller.

Complete the scancode conversion table.
Tell the keyboard not to send idle reports.

Add functions to execute asynchronous requests and use these from
interrupt context.
[I had some feline debugging help here. I noticed that every time Kem,
our kitty, jumped onto the USB keyboard the machine crashed.]

A first stab att supporting console access with a USB keyboard.

Add wscons attachments for USB keyboard.

Add USB support. Supported so far:
* UHCI and OHCI host controllers on PCI
* Hubs
* HID devices withe special drivers for mouse and keyboard
* Printers

remove debug printf

Don't attach Yubikeys as console keyboard.

uhidev(9): Make uhidev state opaque.

This makes the API simpler and clearer and gives us more latitude to
fix bugs in the state management without breaking the ABI.

XXX kernel ABI change to signature of uhidev_get_report_desc and
uhidev_open, and to struct uhidev_attach_arg, requires bump for
uhidev driver modules

uhidev(9): Get the device and interface through attach args.

This way uhidev drivers don't need access to uhidev_softc itself for
it.

ukbd(4): Fix previous change to initial LED flashing.

Without this change the LEDs would get stuck on until the first
keypress. (This also seemed to trigger a crash in heavy load on
bringing aue(4) up and down over and over again while unplugging, but
I'm not sure why and I hope it's not actually related...)

ukbd(4): Avoid races in LED setting on attach.

- Don't reuse sc_delay for LED task -- a keyboard interrupt shortly
after attach might reset sc_delay so that the LEDs never get turned
back off.

- Don't turn the LEDs back off after attach if something else has
already changed them by the time the callout fires.

(And make sure to callout_halt before done this time!)

fix various typos, mainly in comments.

ukbd(4): Wait for callouts and blinking to complete in detach.

This detach routine (and whole driver) has got a lotta other
problems, but let's fix 'em one at a time...

ukbd: blink LEDs asynchronously at boot

Instead of holding up boot by 400ms for each attached ukbd to blink the
keyboard LEDs, turn them on and set a callout to turn them off later.

Merge thorpej-cfargs2.

branches: 1.151.2;
Since there's a bit of code that is conditionally compiled based on
USBVERBOSE, we need to include the opt_usbverbose.h header to get any
possible definition of this macro.

XXX Note that this code will NOT get included in the loadable module
XXX for USBVERBOSE.

branches: 1.150.2;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.149.2;
ukbd: GC some 20 year old code (NFC)

Long ago, code was improved to allow detaching keyboards that were the
console, but the old commen and panic() were #if 0'd instead of
removed.

ukbd: Condition probe-time verbosity on USBVERBOSE

Previously, this driver switched on more verbose messages based on
DIAGNOSTIC. But, the messages weren't about an impossible-to-reach
condition, just extra keys. Change the condition to USBVERBOSE,
documented as serving this purpose.

branches: 1.147.2;
send PMF events for keyboard brightness hotkeys on apple laptops

Summary: Introduce a keyboard event ring buffer for USB console keyboards

For the console keyboard, events must be handled separately from the
interrupt handler, because of the possibility that the user chooses to
drop into DDB by use of the designated key combination. This delayed
handling is tied to the HZ clock through the callout(9) mechanism,
meaning that another keyboard event arriving within 10ms of the
previous one might overwrite its predecessor before it's handled.
This causes dropped events for fast typists - and the situation gets
worse with modern, programmable, keyboards.

This patch introduces a ring buffer in the ukbd_softc data structure,
so that multiple pending events may be safely stored.

revert the 0x% -> %# change for fixed width formats pointed out by uwe.

PR/55068: sc.dying: Fix printf formats:
- no %s/%p for kernel log
- 0x% -> %#
- always %j for kernel log

send PMF events for volume and brightness control keys on Apple keyboards

branches: 1.142.4;
remove explicit 'extern struct cfdriver <my>_cd;' and use ioconf.h

branches: 1.141.4;
tidy up debugging (make it compile with the 'ALL' kernel)

ukbd_cngetc: poll once for data in the buffer, otherwise return type 0 (no data)

Factor out bus-independant HID code so that it can be shared by USB, bluetooth
and i2c.
dev/usb/ukbdmap.c is renamed to dev/hid/hidkbdmap.c
dev/usb/hid.[ch] moved to dev/hid/
usage pages moved from dev/usb/usbhid.h moved to dev/hid/hid.h,
and updated with OpenBSD entries.
bus-independant code moved from dev/usb/ums.c to dev/hid/hidms.c
(the same should be done for keyboard and touchpad drivers)

Needed for the upcoming HID over I2C support, proposed on tech-kern@
on Dec, 1.

Support more varieties of USB keyboard reports.

The previous code asssumed reports would closely match the Bootstrap
Keyboard Protocol. This is no longer always the case, particularly
with higher-end keyboards.

Fix memory leak in report parsing error paths.

branches: 1.136.6;
don't memcpy overlapping buffers, use memmove.
this is undefined behaviour.
CID 1299069

kassert that we aren't overflowing the array.

this assert isn't expected to trigger due to current parameters used, but
to be sure, check.

branches: 1.134.2;
Sort opt_* #includes

branches: 1.133.2;
Make GDIUM_KEYBOARD_HACK compile

Pull in opt_usb.h in _KERNEL_OPT case for various *_DEBUG options.
Makes various driver-specific debugging options work again.

XXX more to fix in dev/usb

Merge nick-nhusb

- API / infrastructure changes to support memory management changes.
- Memory management improvements and bug fixes.
- HCDs should now be MP safe
- conversion to KERNHIST based debug
- FS/LS isoc support on ehci(4).
- conversion to kmem(9)
- Some USB 3 support - mostly from Takahiro HAYASHI (t-hash).
- interrupt transfers now get proper DMA operations
- general bug fixes
- kern/48308
- uhub status notification improvements
- umass(4) probe fix (applied to HEAD already)
- ohci(4) short transfer fix

properly protect uhid's sc_q member with sc_lock. should fix PR#49728.
while here, remove D_MPSAFE from uhid* and all uhid users, as it really
needs all the callers to be safe and they're not.

XXX: pullup-7

branches: 1.129.4; 1.129.6;
Remove usbd_do_request_async. It's callback was calling usbd_free_xfer
from softint context.

Adjust callers appropriately

- usbd_clear_endpoint_stall_async is already triggered via a
usb_task, so simply call usbd_do_request.

- uhidev_set_report_async had one caller in ukbd_set_leds.
Convert this usage to use usb_task as well.

Discussed with mrg@

ifdef variable like their use

Missing AB_QUIET newlines.

branches: 1.126.4; 1.126.6;
Whitespace

- need opt_usb.h if depending on USB_DEBUG
- remove trailing whitespace
- add missing KERNEL_RCSID

branches: 1.124.2;
merge the jmcneill-usbmp branch. many thanks to jared for the
initial work, and every one else who has tested things for me.
this is largely my fault at this point :-)

the main changes are something like:

- usbd_bus_methods{} gains a get_lock() to enable the
host controller to provide a lock for the USB code.
if the lock isn't provided, old-style protection is
(partially) applied.

- ehci/ohci/uhci have been converted to the new
interfaces, including mutex/cv/etc conversion.

- usbdivar.h contains a discussion about locking and
what locks are held for which method calls. more
to come for usbdi(9) here.

- audio drivers (uaudio, umidi, auvitek) have been
properly SMPified now that USB is ready.

- scsi drivers have been modified to take the kernel
lock explicitly before calling into scsi code.

- usb pipes are associated with a lock, that is the
same as the controller lock. (this could be split
up further in the future.)

- several usbfoo_locked() or usbfoo_unlocked()
functions have been added to the usbdi(9) to
enable functionality with or without the USB
lock (per controller) already being held.

the TODO.usbmp file has specific details on what is left to
do, including what device-specific changes should be done now
that the whole framework is ready.

Revert previous commit, as it really is wrong to grow ukbd_trtab to an array
of 16-bit values. While at it, set the correct value for the Sleep button.

Likewise, keep forwarding the keys specific to the Sun Type 7 USB keyboard as
raw input (currently required for X), but making sure to use unassigned and
valid values this time.

Tested with modular-xorg-server 1.6.5nb11 and xf86-input-keyboard 1.3.2nb3.

Implemented extra keys as found on Sun Type 7 USB keyboards, and
according to the documentation mentioned above in this file.

"works here" macallan@, myself

Also lookup and be able to lit the LED for the Compose key. Seems to
require additional modifications to function properly in X though.

No objection on current-users@

Convert keycodes 0x7f, 0x80 and 0x81 to PMF events VOLUME_TOGGLE,
VOLUME_UP and VOLUME_DOWN as observed on my Sun Type 7 USB keyboard, and
according to the documentation mentioned above.

"works here" macallan@ and myself

Indent the trtab_gdium_fn array like surrounding variables.

No objection on current-users@

Fixed a potential out-of-bounds array access when translating keycodes
for the gdium keyboard.

Reviewed by macallan@

minor cleanups from usbmp:
- move usbd_delay_ms() into usbdivar.h in the usb_subr.c section
- minor rcsid fixes
- copyright maintenence

remove any remnants of freebsd/openbsd code.

branches: 1.115.2;
Revert previous due to active usbmp branch(es).

Adjust-away inconsistent and trailing whitespace.

branches: 1.113.4;
only build gdium Fn support with options GDIUM_KEYBOARD_HACK

branches: 1.112.2;
support PMF events as target type in scancode translation tables

support Gdium's Fn key
translation table from OpenBSD

Cap h.loc.count at MAXKEYCODE instead of bailing out. This lets some obscure/
roque keyboards attach.

From loganaden@devio.us (Loganaden Velvindron), thanks!

Support for Apple notebook keyboards, which have a few quirks.
1. On ISO-keyboard the keycodes for the key left of '1' and right of Shift
are swapped.
2. Find the Apple FN key in the report descriptor and do the translations
needed, before passing the keycodes to wscons.
3. Those keyboards only have the left Alt key. AltGr is missing. So it is
emulated when holding down FN together with Alt.

Stop using the compatibility macros USB_ATTACH(), USB_DETACH(),
USB_MATCH(), et cetera. These files produce the same assembly
(according to objdump -d) before and after the change

branches: 1.107.2;
Tweak comment about keyboard mapping.

branches: 1.106.2;
_KERNEL_POT

Simplify activation hooks. (sc_dying must die!)

Fix WSKBD_RAW mode ukbd -> pckbd translation for Pause/Break and
Print Screen/Sys Req keys so xf86-input-keyboard can figure out
what we want.

Additionally, fix dead URL, and add a note that this emulation
is not completely identical to a real pckbd.

These don't need <sys/tty.h>.

branches: 1.102.2;
make this compile

branches: 1.101.2; 1.101.4; 1.101.10;
register with pmf

branches: 1.100.4;
Split device_t and softc for all USB device drivers, and related cosmetic
changes.

Matthias Drochner kindly reviewed this patch, and tested ums, ubt, uaudio
and ral. I tested umass myself.

branches: 1.99.2;
Remove clause 3 and 4 from TNF licenses

branches: 1.98.2; 1.98.4;
use aprint_*_dev and device_xname

branches: 1.97.6;
Use device_t and its accessor functions.

Register _childdetached methods with drivers that attach children.
Wait to set child references to NULL there, instead of doing that
in the detach method.

Replace many uses of USB_DECLARE_DRIVER() with CFATTACH_DECL2().

Add support for function keys F16 to F19 as present on e.g. the new
Apple aluminum keyboard.

Patch contributed by Michael Piotrowski in PR kern/37788, reviewed
by Matthias Drochner.

branches: 1.95.16; 1.95.22;
Kill caddr_t; there will be some MI fallout, but it will be fixed shortly.

branches: 1.94.2; 1.94.4; 1.94.8; 1.94.10;
__unused removal on arguments; approved by core.

- sprinkle __unused on function decls.
- fix a couple of unused bugs
- no more -Wno-unused for i386

branches: 1.92.2; 1.92.4;
add missing initializer

Use device_unit().

branches: 1.90.4; 1.90.6; 1.90.8; 1.90.10; 1.90.12;
merge ktrace-lwp.

branches: 1.89.2;
Provide a header for UKBD_LAYOUT. It makes more sense, and it avoids
quoting issues during the build process.

Reported and checked by spz@.

Fix ifdef botch in previous revision:

The `Static' forward declaration of ukbd_rawrepeat was inside #ifdef
UKBD_REPEAT but not #ifdef DISPLAY_COMPAT_RAWCKBD. The definition and
all other references are inside both #ifdefs. The `static' function
declaration with no definition failed GCC warnings.

Pass GCC warnings by wrapping the declaration with a check that both
CPP tokens are defined.

Don't emulate auto repeat in the keyboard driver, the wskbd driver does that.
Auto repeat emulation can be turned on by defining UKBD_REPEAT, but this
should never be necessary.

If UKBD_LAYOUT isn't defined, but PCKBD_LAYOUT is, use the latter as the
default layout. Fixes half of kern/28668.

branches: 1.85.2; 1.85.8; 1.85.16;
Update URLs for the HID spec.

(Committed at 36000 feet above the Atlantic on board LH418 using
a broadband satellite connection.)

Make sure we are at splusb() while polling.

Remove breaks after returns, unreachable returns and returns after
returns(!).

Get rid of trailing white space.

branches: 1.81.4;
Convert ioctl code to use EPASSTHROUGH instead of -1 or ENOTTY for
indicating an unhandled "command". ERESTART is -1, which can lead to
confusion. ERESTART has been moved to -3 and EPASSTHROUGH has been
placed at -4. No ioctl code should now return -1 anywhere. The
ioctl() system call is now properly restartable.