Subversion Repositories HelenOS

Rev

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