Subversion Repositories HelenOS

Rev

Rev 2071 | Rev 3844 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2005 Jakub Jermar
  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 genericconsole
  30.  * @{
  31.  */
  32. /** @file
  33.  */
  34.  
  35. #ifndef KERN_CHARDEV_H_
  36. #define KERN_CHARDEV_H_
  37.  
  38. #include <arch/types.h>
  39. #include <synch/waitq.h>
  40. #include <synch/spinlock.h>
  41.  
  42. #define CHARDEV_BUFLEN 512
  43.  
  44. struct chardev;
  45.  
  46. /* Character device operations interface. */
  47. typedef struct {
  48.     void (* suspend)(struct chardev *);     /**< Suspend pushing characters. */
  49.     void (* resume)(struct chardev *);      /**< Resume pushing characters. */
  50.     void (* write)(struct chardev *, char c);   /**< Write character to stream. */
  51.     /** Read character directly from device, assume interrupts disabled */
  52.     char (* read)(struct chardev *);
  53. } chardev_operations_t;
  54.  
  55. /** Character input device. */
  56. typedef struct chardev {
  57.     char *name;
  58.    
  59.     waitq_t wq;
  60.     SPINLOCK_DECLARE(lock);     /**< Protects everything below. */
  61.     uint8_t buffer[CHARDEV_BUFLEN];
  62.     count_t counter;
  63.     chardev_operations_t *op;   /**< Implementation of chardev operations. */
  64.     index_t index;
  65.     void *data;
  66. } chardev_t;
  67.  
  68. extern void chardev_initialize(char *name,
  69.                    chardev_t *chardev,
  70.                    chardev_operations_t *op);
  71. extern void chardev_push_character(chardev_t *chardev, uint8_t ch);
  72.  
  73. #endif /* KERN_CHARDEV_H_ */
  74.  
  75. /** @}
  76.  */
  77.