STREAMS Modules                                        usbkbm(7M)



NAME
     usbkbm - keyboard STREAMS module for Sun USB Keyboard

SYNOPSIS
     open("/dev/kbd", ORDWR)


DESCRIPTION
     The  usbkbm STREAMS module processes byte streams  generated
     by  a  keyboard attached to a  USB port.   USB keyboard is a
     member of Human Interface Device  (HID)  Class,  and  usbkbm
     only  supports the keyboard protocol defined in the specifi-
     cation.  Definitions for altering keyboard  translation  and
     reading  events  from  the keyboard are in   and
     .


     The   usbkbm  STREAMS  module  adheres  to  the   interfaces
     exported  by  kb(7M).  Refer  to the  DESCRIPTION section of
     kb(7M) for a discussion of the  keyboard  translation  modes
     and the IOCTL section for the supported  ioctl(2) requests.

  IOCTLS
     USB Keyboard usbkbm returns different values  for  the  fol-
     lowing ioctls than kb(7M):

     KIOCTYPE     This   ioctl()  returns  a  new  keyboard  type
                  defined  for  the   USB keyboard. All types are
                  listed below:


       KBSUN3   Sun Type 3 keyboard
       KBSUN4   Sun Type 4 keyboard
       KBASCI  ASCI terminal masquerading as keyboard
       KBPC     Type 101 PC keyboard
       KBUSB    USB keyboard



     The  USB keyboard type is KBUSB; usbkbm will return  KBUSB
     in response to the  KIOCTYPE ioctl.

     KIOCLAYOUT     The argument is a pointer  to  an   int.  The
                    layout  code  specified  by  the bCountryCode
                    value  returned  in  the  HID  descriptor  is
                    returned  in  the int pointed to by the argu-
                    ment. The countrycodes are defined  in  6.2.1
                    of the  HID 1.0 specifications.


     KIOCMD




SunOS 5.11          Last change: 27 June 2005                   1






STREAMS Modules                                        usbkbm(7M)



                    KBDCMDCLICK/KBDCMDNOCLICK

                        The kb(7M) indicates  that  inappropriate
                        commands  for  particular  keyboards  are
                        ignored. Because  clicking  is  not  sup-
                        ported   on   the  USB  keyboard,  usbkbm
                        ignores this command


                    KBDCMDSETLED

                        Set keyboard LEDs. Same as  kb(7M).


                    KBDCMDGETLAYOUT

                        The country codes defined in 6.2.1 of the
                        HID 1.0 specification are returned.


                    KBDCMDBEL/KBDCMDNOBEL

                        This command is  supported  although  the
                        USB keyboard does not have a buzzer.  The
                        request for the bell is rerouted.


                    KBDCMDRESET

                        There is no notion of resetting the  key-
                        board as there is for the type4 keyboard.
                        usbkbm ignores this command and  does not
                        return an error.



FILES
     /kernel/strmod/usbkbm

         32-bit ELF kernel STREAMS module (x86 platform only)


     /kernel/strmod/sparcv9/usbkbm

         SPARC 64-bit ELF kernel STREAMS module


ATRIBUTES
     See attributes(5) for a description of the following  attri-
     butes:





SunOS 5.11          Last change: 27 June 2005                   2






STREAMS Modules                                        usbkbm(7M)



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Architecture                 PCI-based  systems          
    
     Availability                 SUNWusb                     
    


SEE ALSO
     dumpkeys(1), kbd(1),  loadkeys(1),  ioctl(2),  keytables(4),
     attributes(5), hid(7D), usba(7D), virtualkm(7D), kb(7M)


     STREAMS Programming Guide


     System Administration Guide: Basic Administration


     http:/www.sun.com/io

DIAGN0STICS
     None































SunOS 5.11          Last change: 27 June 2005                   3