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         kVCDarkReboot       = 0x00000001,
  51         kVCAcquireImmediate = 0x00000002,
  52         kVCUsePosition      = 0x00000004,
  53         kVCDarkBackground   = 0x00000008,
  54         kVCLightBackground  = 0x00000010,
  55 };
  56
  57 enum {
  58         kDataRotate0   = 0,
  59         kDataRotate90  = 1,
  60         kDataRotate180 = 2,
  61         kDataRotate270 = 3
  62 };
  63
  64 struct vc_progress_user_options {
  65         uint32_t options;
  66         // fractional position of middle of spinner 0 (0.0) - 0xFFFFFFFF (1.0)
  67         uint32_t x_pos;
  68         uint32_t y_pos;
  69         uint32_t resv[8];
  70 };
  71 typedef struct vc_progress_user_options vc_progress_user_options;
  72
  73
  74 #if XNU_KERNEL_PRIVATE
  75
  76 void vcputc(int, int, int);
  77
  78 int vcgetc(     int             l,
  79     int             u,
  80     boolean_t       wait,
  81     boolean_t       raw );
  82
  83 void video_scroll_up(   void    *start,
  84     void    *end,
  85     void    *dest );
  86
  87 void video_scroll_down( void    *start,  /* HIGH addr */
  88     void    *end,                        /* LOW addr */
  89     void    *dest );                     /* HIGH addr */
  90
  91 struct vc_info {
  92         unsigned int    v_height;       /* pixels */
  93         unsigned int    v_width;        /* pixels */
  94         unsigned int    v_depth;
  95         unsigned int    v_rowbytes;
  96         unsigned long   v_baseaddr;
  97         unsigned int    v_type;
  98         char            v_name[32];
  99         uint64_t        v_physaddr;
 100         unsigned int    v_rows;         /* characters */
 101         unsigned int    v_columns;      /* characters */
 102         unsigned int    v_rowscanbytes; /* Actualy number of bytes used for display per row*/
 103         unsigned int    v_scale;
 104         unsigned int    v_rotate;
 105         unsigned int    v_reserved[3];
 106 };
 107
 108 struct vc_progress_element {
 109         unsigned int        version;
 110         unsigned int        flags;
 111         unsigned int        time;
 112         unsigned char       count;
 113         unsigned char       res[3];
 114         int                 width;
 115         int                 height;
 116         int                 dx;
 117         int                 dy;
 118         int                 transparent;
 119         unsigned int        res2[3];
 120 };
 121 typedef struct vc_progress_element vc_progress_element;
 122
 123 extern struct vc_progress_user_options vc_user_options;
 124
 125 void vc_progress_initialize( vc_progress_element * desc,
 126     const unsigned char * data1x,
 127     const unsigned char * data2x,
 128     const unsigned char * data3x,
 129     const unsigned char * clut );
 130
 131 void vc_progress_set(boolean_t enable, uint32_t vc_delay);
 132
 133 void vc_display_icon( vc_progress_element * desc, const unsigned char * data );
 134
 135 int vc_display_lzss_icon(uint32_t dst_x, uint32_t dst_y,
 136     uint32_t image_width, uint32_t image_height,
 137     const uint8_t *compressed_image,
 138     uint32_t       compressed_size,
 139     const uint8_t *clut);
 140
 141 #if defined(XNU_TARGET_OS_OSX)
 142
 143 extern void vc_enable_progressmeter(int new_value);
 144 extern void vc_set_progressmeter(int new_value);
 145 extern int vc_progressmeter_enable;
 146 extern int vc_progressmeter_value;
 147 extern void vc_progress_setdiskspeed(uint32_t speed);
 148
 149 #endif /* defined(XNU_TARGET_OS_OSX) */
 150
 151 #endif /* XNU_KERNEL_PRIVATE */
 152
 153 #ifdef __cplusplus
 154 }
 155 #endif
 156
 157 #endif /* _VIDEO_CONSOLE_H_ */