Subversion Repositories HelenOS

Rev

Rev 4346 | 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_KCONSOLE_H_
  36. #define KERN_KCONSOLE_H_
  37.  
  38. #include <adt/list.h>
  39. #include <synch/spinlock.h>
  40. #include <ipc/irq.h>
  41.  
  42. #define MAX_CMDLINE       256
  43. #define KCONSOLE_HISTORY  10
  44.  
  45. typedef enum {
  46.     ARG_TYPE_INVALID = 0,
  47.     ARG_TYPE_INT,
  48.     ARG_TYPE_STRING,
  49.     /** Variable type - either symbol or string. */
  50.     ARG_TYPE_VAR
  51. } cmd_arg_type_t;
  52.  
  53. /** Structure representing one argument of kconsole command line. */
  54. typedef struct {
  55.     /** Type descriptor. */
  56.     cmd_arg_type_t type;
  57.     /** Buffer where to store data. */
  58.     void *buffer;
  59.     /** Size of the buffer. */
  60.     size_t len;
  61.     /** Integer value. */
  62.     unative_t intval;
  63.     /** Resulting type of variable arg */
  64.     cmd_arg_type_t vartype;
  65. } cmd_arg_t;
  66.  
  67. /** Structure representing one kconsole command. */
  68. typedef struct {
  69.     /** Command list link. */
  70.     link_t link;
  71.     /** This lock protects everything below. */
  72.     SPINLOCK_DECLARE(lock);
  73.     /** Command name. */
  74.     const char *name;
  75.     /** Textual description. */
  76.     const char *description;
  77.     /** Function implementing the command. */
  78.     int (* func)(cmd_arg_t *);
  79.     /** Number of arguments. */
  80.     count_t argc;
  81.     /** Argument vector. */
  82.     cmd_arg_t *argv;
  83.     /** Function for printing detailed help. */
  84.     void (* help)(void);
  85. } cmd_info_t;
  86.  
  87. extern bool kconsole_notify;
  88. extern irq_t kconsole_irq;
  89.  
  90. SPINLOCK_EXTERN(cmd_lock);
  91. extern link_t cmd_head;
  92.  
  93. extern void kconsole_init(void);
  94. extern void kconsole_notify_init(void);
  95. extern bool kconsole_check_poll(void);
  96. extern void kconsole(char *prompt, char *msg, bool kcon);
  97. extern void kconsole_thread(void *data);
  98.  
  99. extern bool cmd_register(cmd_info_t *cmd);
  100.  
  101. #endif
  102.  
  103. /** @}
  104.  */
  105.