include/linux/console.h

   1 /*
   2  *  linux/include/linux/console.h
   3  *
   4  *  Copyright (C) 1993        Hamish Macdonald
   5  *
   6  * This file is subject to the terms and conditions of the GNU General Public
   7  * License.  See the file COPYING in the main directory of this archive
   8  * for more details.
   9  *
  10  * Changed:
  11  * 10-Mar-94: Arno Griffioen: Conversion for vt100 emulator port from PC LINUX
  12  */
  13
  14 #ifndef _LINUX_CONSOLE_H_
  15 #define _LINUX_CONSOLE_H_ 1
  16
  17 #include <linux/types.h>
  18
  19 struct vc_data;
  20 struct console_font_op;
  21 struct console_font;
  22 struct module;
  23 struct tty_struct;
  24
  25 /*
  26  * this is what the terminal answers to a ESC-Z or csi0c query.
  27  */
  28 #define VT100ID "\033[?1;2c"
  29 #define VT102ID "\033[?6c"
  30
  31 struct consw {
  32         struct module *owner;
  33         const char *(*con_startup)(void);
  34         void    (*con_init)(struct vc_data *, int);
  35         void    (*con_deinit)(struct vc_data *);
  36         void    (*con_clear)(struct vc_data *, int, int, int, int);
  37         void    (*con_putc)(struct vc_data *, int, int, int);
  38         void    (*con_putcs)(struct vc_data *, const unsigned short *, int, int, int);
  39         void    (*con_cursor)(struct vc_data *, int);
  40         int     (*con_scroll)(struct vc_data *, int, int, int, int);
  41         void    (*con_bmove)(struct vc_data *, int, int, int, int, int, int);
  42         int     (*con_switch)(struct vc_data *);
  43         int     (*con_blank)(struct vc_data *, int, int);
  44         int     (*con_font_set)(struct vc_data *, struct console_font *, unsigned);
  45         int     (*con_font_get)(struct vc_data *, struct console_font *);
  46         int     (*con_font_default)(struct vc_data *, struct console_font *, char *);
  47         int     (*con_font_copy)(struct vc_data *, int);
  48         int     (*con_resize)(struct vc_data *, unsigned int, unsigned int,
  49                                unsigned int);
  50         int     (*con_set_palette)(struct vc_data *, unsigned char *);
  51         int     (*con_scrolldelta)(struct vc_data *, int);
  52         int     (*con_set_origin)(struct vc_data *);
  53         void    (*con_save_screen)(struct vc_data *);
  54         u8      (*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8);
  55         void    (*con_invert_region)(struct vc_data *, u16 *, int);
  56         u16    *(*con_screen_pos)(struct vc_data *, int);
  57         unsigned long (*con_getxy)(struct vc_data *, unsigned long, int *, int *);
  58         int     con_preemptible; // can it reschedule from within printk?
  59 };
  60
  61 extern const struct consw *conswitchp;
  62
  63 extern const struct consw dummy_con;    /* dummy console buffer */
  64 extern const struct consw vga_con;      /* VGA text console */
  65 extern const struct consw newport_con;  /* SGI Newport console  */
  66 extern const struct consw prom_con;     /* SPARC PROM console */
  67
  68 int con_is_bound(const struct consw *csw);
  69 int register_con_driver(const struct consw *csw, int first, int last);
  70 int unregister_con_driver(const struct consw *csw);
  71 int take_over_console(const struct consw *sw, int first, int last, int deflt);
  72 void give_up_console(const struct consw *sw);
  73 /* scroll */
  74 #define SM_UP       (1)
  75 #define SM_DOWN     (2)
  76
  77 /* cursor */
  78 #define CM_DRAW     (1)
  79 #define CM_ERASE    (2)
  80 #define CM_MOVE     (3)
  81
  82 /*
  83  * The interface for a console, or any other device that wants to capture
  84  * console messages (printer driver?)
  85  *
  86  * If a console driver is marked CON_BOOT then it will be auto-unregistered
  87  * when the first real console is registered.  This is for early-printk drivers.
  88  */
  89
  90 #define CON_PRINTBUFFER (1)
  91 #define CON_CONSDEV     (2) /* Last on the command line */
  92 #define CON_ENABLED     (4)
  93 #define CON_BOOT        (8)
  94 #define CON_ANYTIME     (16) /* Safe to call when cpu is offline */
  95 #define CON_BRL         (32) /* Used for a braille device */
  96 #define CON_ATOMIC      (64) /* Safe to call in PREEMPT_RT atomic */
  97
  98 #ifdef CONFIG_PREEMPT_RT
  99 # define console_atomic_safe(con)               \
 100         (((con)->flags & CON_ATOMIC) ||         \
 101          (!in_atomic() && !irqs_disabled()) ||  \
 102          (system_state != SYSTEM_RUNNING) ||    \
 103          oops_in_progress)
 104 #else
 105 # define console_atomic_safe(con) (1)
 106 #endif
 107
 108 struct console {
 109         char    name[16];
 110         void    (*write)(struct console *, const char *, unsigned);
 111         int     (*read)(struct console *, char *, unsigned);
 112         struct tty_driver *(*device)(struct console *, int *);
 113         void    (*unblank)(void);
 114         int     (*setup)(struct console *, char *);
 115         int     (*early_setup)(void);
 116         short   flags;
 117         short   index;
 118         int     cflag;
 119         void    *data;
 120         struct   console *next;
 121 };
 122
 123 extern int console_set_on_cmdline;
 124
 125 extern int add_preferred_console(char *name, int idx, char *options);
 126 extern int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options);
 127 extern void register_console(struct console *);
 128 extern int unregister_console(struct console *);
 129 extern struct console *console_drivers;
 130 extern void acquire_console_sem(void);
 131 extern int try_acquire_console_sem(void);
 132 extern void release_console_sem(void);
 133 extern void console_conditional_schedule(void);
 134 extern void console_unblank(void);
 135 extern struct tty_driver *console_device(int *);
 136 extern void console_stop(struct console *);
 137 extern void console_start(struct console *);
 138 extern int is_console_locked(void);
 139 extern int braille_register_console(struct console *, int index,
 140                 char *console_options, char *braille_options);
 141 extern int braille_unregister_console(struct console *);
 142
 143 extern int console_suspend_enabled;
 144
 145 /* Suspend and resume console messages over PM events */
 146 extern void suspend_console(void);
 147 extern void resume_console(void);
 148
 149 int mda_console_init(void);
 150 void prom_con_init(void);
 151
 152 void vcs_make_sysfs(struct tty_struct *tty);
 153 void vcs_remove_sysfs(struct tty_struct *tty);
 154
 155 /* Some debug stub to catch some of the obvious races in the VT code */
 156 #if 1
 157 #define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
 158 #else
 159 #define WARN_CONSOLE_UNLOCKED()
 160 #endif
 161
 162 /* VESA Blanking Levels */
 163 #define VESA_NO_BLANKING        0
 164 #define VESA_VSYNC_SUSPEND      1
 165 #define VESA_HSYNC_SUSPEND      2
 166 #define VESA_POWERDOWN          3
 167
 168 #ifdef CONFIG_VGA_CONSOLE
 169 extern bool vgacon_text_force(void);
 170 #endif
 171
 172 #endif /* _LINUX_CONSOLE_H */