xref: /xnu-11417.140.69/osfmk/console/video_console.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
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(char);
77 void vcputc_options(char, bool);
78 
79 void video_scroll_up(   void    *start,
80     void    *end,
81     void    *dest );
82 
83 void video_scroll_down( void    *start,  /* HIGH addr */
84     void    *end,                        /* LOW addr */
85     void    *dest );                     /* HIGH addr */
86 
87 struct vc_info {
88 	unsigned int    v_height;       /* pixels */
89 	unsigned int    v_width;        /* pixels */
90 	unsigned int    v_depth;
91 	unsigned int    v_rowbytes;
92 	unsigned long   v_baseaddr;
93 	unsigned int    v_type;
94 	char            v_name[32];
95 	uint64_t        v_physaddr;
96 	unsigned int    v_rows;         /* characters */
97 	unsigned int    v_columns;      /* characters */
98 	unsigned int    v_rowscanbytes; /* Actualy number of bytes used for display per row*/
99 	unsigned int    v_scale;
100 	unsigned int    v_rotate;
101 	unsigned int    v_reserved[3];
102 };
103 
104 struct vc_progress_element {
105 	unsigned int        version;
106 	unsigned int        flags;
107 	unsigned int        time;
108 	unsigned char       count;
109 	unsigned char       res[3];
110 	int                 width;
111 	int                 height;
112 	int                 dx;
113 	int                 dy;
114 	int                 transparent;
115 	unsigned int        res2[3];
116 };
117 typedef struct vc_progress_element vc_progress_element;
118 
119 extern struct vc_progress_user_options vc_user_options;
120 
121 void vc_progress_initialize( vc_progress_element * desc,
122     const unsigned char * data1x,
123     const unsigned char * data2x,
124     const unsigned char * data3x,
125     const unsigned char * clut );
126 
127 void vc_progress_set(boolean_t enable, uint32_t vc_delay);
128 
129 void vc_display_icon( vc_progress_element * desc, const unsigned char * data );
130 
131 int vc_display_lzss_icon(uint32_t dst_x, uint32_t dst_y,
132     uint32_t image_width, uint32_t image_height,
133     const uint8_t *compressed_image,
134     uint32_t       compressed_size,
135     const uint8_t *clut);
136 
137 #if defined(XNU_TARGET_OS_OSX)
138 
139 extern void vc_enable_progressmeter(int new_value);
140 extern void vc_set_progressmeter(int new_value);
141 extern int vc_progressmeter_enable;
142 extern int vc_progressmeter_value;
143 extern void vc_progress_setdiskspeed(uint32_t speed);
144 
145 #endif /* defined(XNU_TARGET_OS_OSX) */
146 
147 #endif /* XNU_KERNEL_PRIVATE */
148 
149 #ifdef __cplusplus
150 }
151 #endif
152 
153 #endif /* _VIDEO_CONSOLE_H_ */
154