1/*-
2 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer as
10 *    the first lines of this file unmodified.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28
29#ifndef _DEV_FB_SPLASHREG_H_
30#define _DEV_FB_SPLASHREG_H_
31
32#define SPLASH_IMAGE	"splash_image_data"
33
34struct video_adapter;
35
36struct image_decoder {
37	char		*name;
38	int		(*init)(struct video_adapter *adp);
39	int		(*term)(struct video_adapter *adp);
40	int		(*splash)(struct video_adapter *adp, int on);
41	char		*data_type;
42	void		*data;
43	size_t		data_size;
44};
45
46typedef struct image_decoder	splash_decoder_t;
47typedef struct image_decoder	scrn_saver_t;
48
49#define SPLASH_DECODER(name, sw)				\
50	static int name##_modevent(module_t mod, int type, void *data) \
51	{							\
52		switch ((modeventtype_t)type) {			\
53		case MOD_LOAD:					\
54			return splash_register(&sw);		\
55		case MOD_UNLOAD:				\
56			return splash_unregister(&sw);		\
57		default:					\
58			return EOPNOTSUPP;			\
59			break;					\
60		}						\
61		return 0;					\
62	}							\
63	static moduledata_t name##_mod = {			\
64		#name, 						\
65		name##_modevent,				\
66		NULL						\
67	};							\
68	DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY); \
69	MODULE_DEPEND(name, splash, 1, 1, 1)
70
71#define SAVER_MODULE(name, sw)					\
72	static int name##_modevent(module_t mod, int type, void *data) \
73	{							\
74		switch ((modeventtype_t)type) {			\
75		case MOD_LOAD:					\
76			return splash_register(&sw);		\
77		case MOD_UNLOAD:				\
78			return splash_unregister(&sw);		\
79		default:					\
80			return EOPNOTSUPP;			\
81			break;					\
82		}						\
83		return 0;					\
84	}							\
85	static moduledata_t name##_mod = {			\
86		#name, 						\
87		name##_modevent,				\
88		NULL						\
89	};							\
90	DECLARE_MODULE(name, name##_mod, SI_SUB_PSEUDO, SI_ORDER_MIDDLE); \
91	MODULE_DEPEND(name, splash, 1, 1, 1)
92
93/* entry point for the splash image decoder */
94int	splash_register(splash_decoder_t *decoder);
95int	splash_unregister(splash_decoder_t *decoder);
96
97/* entry points for the console driver */
98int	splash_init(video_adapter_t *adp, int (*callback)(int, void *),
99		    void *arg);
100int	splash_term(video_adapter_t *adp);
101int	splash(video_adapter_t *adp, int on);
102
103/* event types for the callback function */
104#define SPLASH_INIT	0
105#define SPLASH_TERM	1
106
107#endif /* _DEV_FB_SPLASHREG_H_ */
108