| 1 | /*
|
|---|
| 2 | * Copyright (c) 2006 Martin Decky
|
|---|
| 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 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - 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 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 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
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 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
|
|---|
| 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
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup genericmm
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | */
|
|---|
| 34 |
|
|---|
| 35 | #ifndef KERN_RD_H_
|
|---|
| 36 | #define KERN_RD_H_
|
|---|
| 37 |
|
|---|
| 38 | #include <arch/types.h>
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * RAM disk version
|
|---|
| 42 | */
|
|---|
| 43 | #define RD_VERSION 0
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * RAM disk magic number
|
|---|
| 47 | */
|
|---|
| 48 | #define RD_MAGIC_SIZE 4
|
|---|
| 49 | #define RD_MAG0 'H'
|
|---|
| 50 | #define RD_MAG1 'O'
|
|---|
| 51 | #define RD_MAG2 'R'
|
|---|
| 52 | #define RD_MAG3 'D'
|
|---|
| 53 |
|
|---|
| 54 | /**
|
|---|
| 55 | * RAM disk data encoding types
|
|---|
| 56 | */
|
|---|
| 57 | #define RD_DATA_NONE 0
|
|---|
| 58 | #define RD_DATA_LSB 1 /* Least significant byte first (little endian) */
|
|---|
| 59 | #define RD_DATA_MSB 2 /* Most signigicant byte first (big endian) */
|
|---|
| 60 |
|
|---|
| 61 | /**
|
|---|
| 62 | * RAM disk error return codes
|
|---|
| 63 | */
|
|---|
| 64 | #define RE_OK 0 /* No error */
|
|---|
| 65 | #define RE_INVALID 1 /* Invalid RAM disk image */
|
|---|
| 66 | #define RE_UNSUPPORTED 2 /* Non-supported image (e.g. wrong version) */
|
|---|
| 67 |
|
|---|
| 68 | /** RAM disk header */
|
|---|
| 69 | typedef struct {
|
|---|
| 70 | uint8_t magic[RD_MAGIC_SIZE];
|
|---|
| 71 | uint8_t version;
|
|---|
| 72 | uint8_t data_type;
|
|---|
| 73 | uint32_t header_size;
|
|---|
| 74 | uint64_t data_size;
|
|---|
| 75 | } rd_header;
|
|---|
| 76 |
|
|---|
| 77 | extern int init_rd(rd_header * addr, size_t size);
|
|---|
| 78 |
|
|---|
| 79 | #endif
|
|---|
| 80 |
|
|---|
| 81 | /** @}
|
|---|
| 82 | */
|
|---|
