uspace/kbd/include/key_buffer.h

   1 /*
   2  * Copyright (c) 2006 Josef Cejka
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - 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  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup kbdgen
  30  * @brief       HelenOS generic uspace keyboard handler.
  31  * @ingroup  kbd
  32  * @{
  33  */
  34 /** @file
  35  */
  36
  37 #ifndef __KEY_BUFFER_H__
  38 #define __KEY_BUFFER_H__
  39
  40 #include <types.h>
  41
  42 /** Size of buffer for pressed keys */
  43 #define KEYBUFFER_SIZE 128
  44
  45 typedef struct {
  46         int fifo[KEYBUFFER_SIZE];
  47         unsigned long head;
  48         unsigned long tail;
  49         unsigned long items;
  50 } keybuffer_t;
  51
  52 void keybuffer_free(keybuffer_t *keybuffer);
  53 void keybuffer_init(keybuffer_t *keybuffer);
  54 int keybuffer_available(keybuffer_t *keybuffer);
  55 int keybuffer_empty(keybuffer_t *keybuffer);
  56 void keybuffer_push(keybuffer_t *keybuffer, int key);
  57 int keybuffer_pop(keybuffer_t *keybuffer, int *c);
  58
  59 #endif
  60
  61 /**
  62  * @}
  63  */
  64