osfmk/console/video_console.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * @APPLE_FREE_COPYRIGHT@
  33  */
  34
  35 #ifndef _VIDEO_CONSOLE_H_
  36 #define _VIDEO_CONSOLE_H_
  37
  38 #include <device/device_types.h>
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #define kVCSysctlProgressOptions      "kern.progressoptions"
  45 #define kVCSysctlConsoleOptions       "kern.consoleoptions"
  46 #define kVCSysctlProgressMeterEnable  "kern.progressmeterenable"
  47 #define kVCSysctlProgressMeter        "kern.progressmeter"
  48
  49 enum
  50 {
  51     kVCDarkReboot       = 0x00000001,
  52     kVCAcquireImmediate = 0x00000002,
  53     kVCUsePosition      = 0x00000004,
  54     kVCDarkBackground   = 0x00000008,
  55     kVCLightBackground  = 0x00000010,
  56 };
  57
  58 struct vc_progress_user_options {
  59     uint32_t options;
  60     // fractional position of middle of spinner 0 (0.0) - 0xFFFFFFFF (1.0)
  61     uint32_t x_pos;
  62     uint32_t y_pos;
  63     uint32_t resv[8];
  64 };
  65 typedef struct vc_progress_user_options vc_progress_user_options;
  66
  67
  68 #if XNU_KERNEL_PRIVATE
  69
  70 void vcputc(int, int, int);
  71
  72 int vcgetc(     int             l,
  73                 int             u,
  74                 boolean_t       wait,
  75                 boolean_t       raw );
  76
  77 void video_scroll_up(   void    *start,
  78                         void    *end,
  79                         void    *dest );
  80
  81 void video_scroll_down( void    *start,  /* HIGH addr */
  82                         void    *end,    /* LOW addr */
  83                         void    *dest ); /* HIGH addr */
  84
  85 struct vc_info
  86 {
  87         unsigned int    v_height;       /* pixels */
  88         unsigned int    v_width;        /* pixels */
  89         unsigned int    v_depth;
  90         unsigned int    v_rowbytes;
  91         unsigned long   v_baseaddr;
  92         unsigned int    v_type;
  93         char            v_name[32];
  94         uint64_t        v_physaddr;
  95         unsigned int    v_rows;         /* characters */
  96         unsigned int    v_columns;      /* characters */
  97         unsigned int    v_rowscanbytes; /* Actualy number of bytes used for display per row*/
  98         unsigned int    v_scale;
  99         unsigned int    v_rotate;
 100         unsigned int    v_reserved[3];
 101 };
 102
 103 struct vc_progress_element {
 104     unsigned int        version;
 105     unsigned int        flags;
 106     unsigned int        time;
 107     unsigned char       count;
 108     unsigned char       res[3];
 109     int                 width;
 110     int                 height;
 111     int                 dx;
 112     int                 dy;
 113     int                 transparent;
 114     unsigned int        res2[3];
 115 };
 116 typedef struct vc_progress_element vc_progress_element;
 117
 118 extern struct vc_progress_user_options vc_user_options;
 119
 120 void vc_progress_initialize( vc_progress_element * desc,
 121                                     const unsigned char * data1x,
 122                                     const unsigned char * data2x,
 123                                     const unsigned char * data3x,
 124                                     const unsigned char * clut );
 125
 126 void vc_progress_set(boolean_t enable, uint32_t vc_delay);
 127
 128 void vc_display_icon( vc_progress_element * desc, const unsigned char * data );
 129
 130 int vc_display_lzss_icon(uint32_t dst_x,       uint32_t dst_y,
 131                      uint32_t image_width, uint32_t image_height,
 132                      const uint8_t *compressed_image,
 133                      uint32_t       compressed_size,
 134                      const uint8_t *clut);
 135
 136
 137 extern void vc_enable_progressmeter(int new_value);
 138 extern void vc_set_progressmeter(int new_value);
 139 extern int vc_progressmeter_enable;
 140 extern int vc_progressmeter_value;
 141 extern void vc_progress_setdiskspeed(uint32_t speed);
 142
 143
 144 #endif /* XNU_KERNEL_PRIVATE */
 145
 146 #ifdef __cplusplus
 147 }
 148 #endif
 149
 150 #endif /* _VIDEO_CONSOLE_H_ */