WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/lib/rd.h


/*
 * Copyright (c) 2006 Martin Decky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericmm
 * @{
 */
/** @file
 */
 
#ifndef KERN_RD_H_
#define KERN_RD_H_
 
#include <arch/types.h>
#include <typedefs.h>
 
/**
 * RAM disk version
 */
#define RD_VERSION  0
 
/**
 * RAM disk magic number
 */
#define RD_MAGIC_SIZE   4
#define RD_MAG0         'H'
#define RD_MAG1         'O'
#define RD_MAG2         'R'
#define RD_MAG3         'D'
 
/**
 * RAM disk data encoding types
 */
#define RD_DATA_NONE    0
#define RD_DATA_LSB     1       /* Least significant byte first (little endian) */
#define RD_DATA_MSB     2       /* Most signigicant byte first (big endian) */
 
/**
 * RAM disk error return codes
 */
#define RE_OK           0   /* No error */
#define RE_INVALID      1   /* Invalid RAM disk image */
#define RE_UNSUPPORTED      2   /* Non-supported image (e.g. wrong version) */
 
/** RAM disk header */
typedef struct {
    uint8_t magic[RD_MAGIC_SIZE];
    uint8_t version;
    uint8_t data_type;
    uint32_t header_size;
    uint64_t data_size;
} rd_header;
 
extern int init_rd(rd_header * addr, size_t size);
 
#endif
 
/** @}
 */
 

Rev 2005	Rev 2071
1	/*	1	/*
2	* Copyright (C) 2006 Martin Decky	2	* Copyright (c) 2006 Martin Decky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genericmm	29	/** @addtogroup genericmm
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_RD_H_	35	#ifndef KERN_RD_H_
36	#define KERN_RD_H_	36	#define KERN_RD_H_
37		37
38	#include <arch/types.h>	38	#include <arch/types.h>
39	#include <typedefs.h>	39	#include <typedefs.h>
40		40
41	/**	41	/**
42	* RAM disk version	42	* RAM disk version
43	*/	43	*/
44	#define RD_VERSION 0	44	#define RD_VERSION 0
45		45
46	/**	46	/**
47	* RAM disk magic number	47	* RAM disk magic number
48	*/	48	*/
49	#define RD_MAGIC_SIZE 4	49	#define RD_MAGIC_SIZE 4
50	#define RD_MAG0 'H'	50	#define RD_MAG0 'H'
51	#define RD_MAG1 'O'	51	#define RD_MAG1 'O'
52	#define RD_MAG2 'R'	52	#define RD_MAG2 'R'
53	#define RD_MAG3 'D'	53	#define RD_MAG3 'D'
54		54
55	/**	55	/**
56	* RAM disk data encoding types	56	* RAM disk data encoding types
57	*/	57	*/
58	#define RD_DATA_NONE 0	58	#define RD_DATA_NONE 0
59	#define RD_DATA_LSB 1 /* Least significant byte first (little endian) */	59	#define RD_DATA_LSB 1 /* Least significant byte first (little endian) */
60	#define RD_DATA_MSB 2 /* Most signigicant byte first (big endian) */	60	#define RD_DATA_MSB 2 /* Most signigicant byte first (big endian) */
61		61
62	/**	62	/**
63	* RAM disk error return codes	63	* RAM disk error return codes
64	*/	64	*/
65	#define RE_OK 0 /* No error */	65	#define RE_OK 0 /* No error */
66	#define RE_INVALID 1 /* Invalid RAM disk image */	66	#define RE_INVALID 1 /* Invalid RAM disk image */
67	#define RE_UNSUPPORTED 2 /* Non-supported image (e.g. wrong version) */	67	#define RE_UNSUPPORTED 2 /* Non-supported image (e.g. wrong version) */
68		68
69	/** RAM disk header */	69	/** RAM disk header */
70	typedef struct {	70	typedef struct {
71	uint8_t magic[RD_MAGIC_SIZE];	71	uint8_t magic[RD_MAGIC_SIZE];
72	uint8_t version;	72	uint8_t version;
73	uint8_t data_type;	73	uint8_t data_type;
74	uint32_t header_size;	74	uint32_t header_size;
75	uint64_t data_size;	75	uint64_t data_size;
76	} rd_header;	76	} rd_header;
77		77
78	extern int init_rd(rd_header * addr, size_t size);	78	extern int init_rd(rd_header * addr, size_t size);
79		79
80	#endif	80	#endif
81		81
82	/** @}	82	/** @}
83	*/	83	*/
84		84

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/lib/rd.h – Rev 2005 → 2071