[apple/xnu.git] / osfmk / console / video_console.h

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/*
 * @APPLE_FREE_COPYRIGHT@
 */

#ifndef _VIDEO_CONSOLE_H_
#define _VIDEO_CONSOLE_H_

#include <device/device_types.h>

#ifdef __cplusplus
extern "C" {
#endif

#define kVCSysctlProgressOptions      "kern.progressoptions"
#define kVCSysctlConsoleOptions       "kern.consoleoptions"
#define kVCSysctlProgressMeterEnable  "kern.progressmeterenable"
#define kVCSysctlProgressMeter        "kern.progressmeter"

enum
{
    kVCDarkReboot       = 0x00000001,
    kVCAcquireImmediate = 0x00000002,
    kVCUsePosition      = 0x00000004,
    kVCDarkBackground   = 0x00000008,
    kVCLightBackground  = 0x00000010,
};

struct vc_progress_user_options {
    uint32_t options;
    // fractional position of middle of spinner 0 (0.0) - 0xFFFFFFFF (1.0)
    uint32_t x_pos;
    uint32_t y_pos;
    uint32_t resv[8];
};
typedef struct vc_progress_user_options vc_progress_user_options;


#if XNU_KERNEL_PRIVATE

void vcputc(int, int, int);

int vcgetc(	int		l,
		int		u,
		boolean_t	wait,
		boolean_t	raw );

void video_scroll_up(	void	*start,
			void	*end,
			void	*dest );

void video_scroll_down(	void	*start,  /* HIGH addr */
			void	*end,    /* LOW addr */
			void	*dest ); /* HIGH addr */

struct vc_info
{
	unsigned int	v_height;	/* pixels */
	unsigned int	v_width;	/* pixels */
	unsigned int	v_depth;
	unsigned int	v_rowbytes;
	unsigned long	v_baseaddr;
	unsigned int	v_type;
	char		v_name[32];
	uint64_t	v_physaddr;
	unsigned int	v_rows;		/* characters */
	unsigned int	v_columns;	/* characters */
	unsigned int	v_rowscanbytes;	/* Actualy number of bytes used for display per row*/
	unsigned int	v_scale;	
	unsigned int	v_rotate;
	unsigned int	v_reserved[3];
};

struct vc_progress_element {
    unsigned int	version;
    unsigned int	flags;
    unsigned int	time;
    unsigned char	count;
    unsigned char	res[3];
    int			width;
    int			height;
    int			dx;
    int			dy;
    int			transparent;
    unsigned int	res2[3];
};
typedef struct vc_progress_element vc_progress_element;

extern struct vc_progress_user_options vc_user_options;

void vc_progress_initialize( vc_progress_element * desc,
                                    const unsigned char * data1x,
                                    const unsigned char * data2x,
                                    const unsigned char * data3x,
                                    const unsigned char * clut );

void vc_progress_set(boolean_t enable, uint32_t vc_delay);

void vc_display_icon( vc_progress_element * desc, const unsigned char * data );

int vc_display_lzss_icon(uint32_t dst_x,       uint32_t dst_y,
                     uint32_t image_width, uint32_t image_height,
                     const uint8_t *compressed_image,
                     uint32_t       compressed_size, 
                     const uint8_t *clut);

#if !CONFIG_EMBEDDED

extern void vc_enable_progressmeter(int new_value);
extern void vc_set_progressmeter(int new_value);
extern int vc_progressmeter_enable;
extern int vc_progressmeter_value;
extern void vc_progress_setdiskspeed(uint32_t speed);

#endif /* !CONFIG_EMBEDDED */

#endif /* XNU_KERNEL_PRIVATE */

#ifdef __cplusplus
}
#endif

#endif /* _VIDEO_CONSOLE_H_ */
Commit	Line	Data
de355530	1	/*
2d21ac55	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
de355530	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
de355530	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
de355530 A	27	*/
de355530 A	28	/*
55e303ae	29	* @OSF_COPYRIGHT@
de355530 A	30	*/
	31	/*
	32	* @APPLE_FREE_COPYRIGHT@
	33	*/
de355530	34
55e303ae A	35	#ifndef _VIDEO_CONSOLE_H_
	36	#define _VIDEO_CONSOLE_H_
	37
	38	#include <device/device_types.h>
	39
13f56ec4 A	40	#ifdef __cplusplus
	41	extern "C" {
	42	#endif
	43
490019cf A	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
2d21ac55	70	void vcputc(int, int, int);
55e303ae A	71
	72	int vcgetc( int l,
	73	int u,
	74	boolean_t wait,
	75	boolean_t raw );
	76
b0d623f7 A	77	void video_scroll_up( void *start,
	78	void *end,
	79	void *dest );
55e303ae	80
b0d623f7 A	81	void video_scroll_down( void start, / HIGH addr */
	82	void end, / LOW addr */
	83	void dest ); / HIGH addr */
55e303ae A	84
	85	struct vc_info
	86	{
316670eb A	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;
490019cf A	99	unsigned int v_rotate;
490019cf A	100	unsigned int v_reserved[3];
13f56ec4 A	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];
55e303ae	115	};
13f56ec4 A	116	typedef struct vc_progress_element vc_progress_element;
13f56ec4 A	117
490019cf A	118	extern struct vc_progress_user_options vc_user_options;
490019cf A	119
13f56ec4 A	120	void vc_progress_initialize( vc_progress_element * desc,
	121	const unsigned char * data1x,
	122	const unsigned char * data2x,
fe8ab488	123	const unsigned char * data3x,
13f56ec4 A	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
5ba3f43e	136	#if !CONFIG_EMBEDDED
13f56ec4 A	137
	138	extern void vc_enable_progressmeter(int new_value);
	139	extern void vc_set_progressmeter(int new_value);
fe8ab488 A	140	extern int vc_progressmeter_enable;
	141	extern int vc_progressmeter_value;
	142	extern void vc_progress_setdiskspeed(uint32_t speed);
13f56ec4	143
5ba3f43e	144	#endif /* !CONFIG_EMBEDDED */
13f56ec4	145
490019cf	146	#endif /* XNU_KERNEL_PRIVATE */
3e170ce0	147
13f56ec4 A	148	#ifdef __cplusplus
	149	}
	150	#endif
55e303ae A	151
55e303ae A	152	#endif /* _VIDEO_CONSOLE_H_ */