protocol/ps2.h

   1 /*
   2 Copyright 2010,2011 Jun WAKO <wakojun@gmail.com>
   3
   4 This software is licensed with a Modified BSD License.
   5 All of this is supposed to be Free Software, Open Source, DFSG-free,
   6 GPL-compatible, and OK to use in both free and proprietary applications.
   7 Additions and corrections to this file are welcome.
   8
   9
  10 Redistribution and use in source and binary forms, with or without
  11 modification, are permitted provided that the following conditions are met:
  12
  13 * Redistributions of source code must retain the above copyright
  14   notice, this list of conditions and the following disclaimer.
  15
  16 * Redistributions in binary form must reproduce the above copyright
  17   notice, this list of conditions and the following disclaimer in
  18   the documentation and/or other materials provided with the
  19   distribution.
  20
  21 * Neither the name of the copyright holders nor the names of
  22   contributors may be used to endorse or promote products derived
  23   from this software without specific prior written permission.
  24
  25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29 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 PS2_H
  39 #define PS2_H
  40 /*
  41  * Primitive PS/2 Library for AVR
  42  */
  43
  44
  45 /* port settings for clock and data line */
  46 #if !(defined(PS2_CLOCK_PORT) && \
  47       defined(PS2_CLOCK_PIN) && \
  48       defined(PS2_CLOCK_DDR) && \
  49       defined(PS2_CLOCK_BIT))
  50 #   error "PS/2 clock port setting is required in config.h"
  51 #endif
  52
  53 #if !(defined(PS2_DATA_PORT) && \
  54       defined(PS2_DATA_PIN) && \
  55       defined(PS2_DATA_DDR) && \
  56       defined(PS2_DATA_BIT))
  57 #   error "PS/2 data port setting is required in config.h"
  58 #endif
  59
  60 #define PS2_ACK         0xFA
  61 #define PS2_RESEND      0xFE
  62 #define PS2_SET_LED     0xED
  63
  64 #define PS2_ERR_NONE    0
  65 #define PS2_ERR_PARITY  0x10
  66
  67 #define PS2_LED_SCROLL_LOCK 0
  68 #define PS2_LED_NUM_LOCK    1
  69 #define PS2_LED_CAPS_LOCK   2
  70
  71
  72 extern uint8_t ps2_error;
  73
  74 /* host role */
  75 void ps2_host_init(void);
  76 uint8_t ps2_host_send(uint8_t data);
  77 uint8_t ps2_host_recv_response(void);
  78 uint8_t ps2_host_recv(void);
  79 void ps2_host_set_led(uint8_t usb_led);
  80
  81 /* device role */
  82
  83 #endif