aboutsummaryrefslogtreecommitdiffstats
path: root/Drivers/Block/ramdisk/ramdisk.h
blob: 398c9163862ed33f310e2658189c8f1e50402e52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
 * Copyright (c) 1999, 2000
 * Intel Corporation.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. All advertising materials mentioning features or use of this software must
 *    display the following acknowledgement:
 *
 *    This product includes software developed by Intel Corporation and its
 *    contributors.
 *
 * 4. Neither the name of Intel Corporation or its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY INTEL CORPORATION AND CONTRIBUTORS ``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 INTEL CORPORATION OR CONTRIBUTORS 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.
 *
 */

#ifndef _RAMDISK_H_
#define _RAMDISK_H_

#pragma pack(1)
/* RAM disk device path structure.
 * Will use Vendor Messaging Device Path.
 */
typedef struct sRAM_DISK_DEVICE_PATH
{
  EFI_DEVICE_PATH Header;
  EFI_GUID        Guid;
  UINT8           DiskId[8];
  EFI_DEVICE_PATH EndDevicePath;
} RAM_DISK_DEVICE_PATH;

/* FAT16 boot sector definition */
typedef struct sBOOTSEC
{
  UINT8  BS_jmpBoot[3];
  UINT8  BS_OEMName[8];
  UINT16 BPB_BytsPerSec;
  UINT8  BPB_SecPerClus;
  UINT16 BPB_RsvdSecCnt;
  UINT8  BPB_NumFATs;
  UINT16 BPB_RootEntCnt;
  UINT16 BPB_TotSec16;
  UINT8  BPB_Media;
  UINT16 BPB_FATSz16;
  UINT16 BPB_SecPerTrk;
  UINT16 BPB_NumHeads;
  UINT32 BPB_HiddSec;
  UINT32 BPB_TotSec32;
  UINT8  BS_DrvNum;
  UINT8  BS_Reserved1;
  UINT8  BS_BootSig;
  UINT32 BS_VolID;
  UINT8  BS_VolLab[11];
  UINT8  BS_FilSysType[8];
  UINT8  BS_Code[448];
  UINT16 BS_Sig;
} BOOTSEC;

#pragma pack()

/* structure for total sectors to cluster size lookup */
typedef struct sFAT16TABLE
{
  UINTN size;
  UINT8  spc;
} FAT16TABLE;

#define PBLOCK_DEVICE_SIGNATURE SIGNATURE_32('r', 'd', 's', 'k')

/* Ramdisk device info structure */
typedef struct sRAM_DISKDEV
{
  UINTN                Signature;
  EFI_HANDLE           Handle;
  EFI_PHYSICAL_ADDRESS Start;
  EFI_BLOCK_IO         BlkIo;
  EFI_BLOCK_IO_MEDIA   Media;
  EFI_DEVICE_PATH      *DevicePath;
} RAM_DISK_DEV;

/* Macro finds the device info structure given a ramdisk BlkIo interface */
#define RAM_DISK_FROM_THIS(a) CR(a,RAM_DISK_DEV,BlkIo,PBLOCK_DEVICE_SIGNATURE)

/* Prototypes */
EFI_STATUS InitializeRamDiskDriver(
  IN EFI_HANDLE       ImageHandle,
  IN EFI_SYSTEM_TABLE *SystemTable);

STATIC VOID FormatRamdisk(
  IN VOID*  pStart,
  IN UINT32 Size);

STATIC EFI_STATUS RamDiskReadBlocks(
  IN EFI_BLOCK_IO *This,
  IN UINT32       MediaId,
  IN EFI_LBA      LBA,
  IN UINTN        BufferSize,
  OUT VOID        *Buffer);

STATIC EFI_STATUS RamDiskWriteBlocks(
  IN EFI_BLOCK_IO *This,
  IN UINT32       MediaId,
  IN EFI_LBA      LBA,
  IN UINTN        BufferSize,
  IN VOID         *Buffer);

STATIC EFI_STATUS RamDiskFlushBlocks(
  IN EFI_BLOCK_IO *This);

#endif