firmware/export/storage.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Alan Korr
  11  * Copyright (C) 2008 by Frank Gevaerts
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2
  16  * of the License, or (at your option) any later version.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ****************************************************************************/
  22 #ifndef __STORAGE_H__
  23 #define __STORAGE_H__
  24
  25 #include <stdbool.h>
  26 #include "config.h" /* for HAVE_MULTIDRIVE or not */
  27 #include "mv.h"
  28
  29 #if (CONFIG_STORAGE & STORAGE_SD)
  30 #include "sd.h"
  31 #endif
  32 #if (CONFIG_STORAGE & STORAGE_MMC)
  33 #include "mmc.h"
  34 #endif
  35 #if (CONFIG_STORAGE & STORAGE_ATA)
  36 #include "ata.h"
  37 #endif
  38 #if (CONFIG_STORAGE & STORAGE_NAND)
  39 #include "nand.h"
  40 #endif
  41 #if (CONFIG_STORAGE & STORAGE_RAMDISK)
  42 #include "ramdisk.h"
  43 #endif
  44
  45 struct storage_info
  46 {
  47     unsigned int sector_size;
  48     unsigned int num_sectors;
  49     char *vendor;
  50     char *product;
  51     char *revision;
  52 };
  53
  54 #if !defined(SIMULATOR) && !defined(CONFIG_STORAGE_MULTI)
  55 /* storage_spindown, storage_sleep and storage_spin are passed as
  56  * pointers, which doesn't work with argument-macros.
  57  */
  58     #define storage_num_drives() NUM_DRIVES
  59     #if (CONFIG_STORAGE & STORAGE_ATA)
  60         #define storage_spindown ata_spindown
  61         #define storage_sleep ata_sleep
  62         #define storage_spin ata_spin
  63
  64         #define storage_enable(on) ata_enable(on)
  65         #define storage_sleepnow() ata_sleepnow()
  66         #define storage_disk_is_active() ata_disk_is_active()
  67         #define storage_soft_reset() ata_soft_reset()
  68         #define storage_init() ata_init()
  69         #define storage_close() ata_close()
  70         #define storage_read_sectors(drive, start, count, buf) ata_read_sectors(IF_MD2(drive,) start, count, buf)
  71         #define storage_write_sectors(drive, start, count, buf) ata_write_sectors(IF_MD2(drive,) start, count, buf)
  72         #ifdef HAVE_STORAGE_FLUSH
  73             #define storage_flush() (void)0
  74         #endif
  75         #define storage_last_disk_activity() ata_last_disk_activity()
  76         #define storage_spinup_time() ata_spinup_time()
  77         #define storage_get_identify() ata_get_identify()
  78
  79         #ifdef STORAGE_GET_INFO
  80             #define storage_get_info(drive, info) ata_get_info(IF_MD2(drive,) info)
  81         #endif
  82         #ifdef HAVE_HOTSWAP
  83             #define storage_removable(drive) ata_removable(IF_MD(drive))
  84             #define storage_present(drive) ata_present(IF_MD(drive))
  85         #endif
  86     #elif (CONFIG_STORAGE & STORAGE_SD)
  87         #define storage_spindown sd_spindown
  88         #define storage_sleep sd_sleep
  89         #define storage_spin sd_spin
  90
  91         #define storage_enable(on) sd_enable(on)
  92         #define storage_sleepnow() sd_sleepnow()
  93         #define storage_disk_is_active() 0
  94         #define storage_soft_reset() (void)0
  95         #define storage_init() sd_init()
  96         #define storage_read_sectors(drive, start, count, buf) sd_read_sectors(IF_MD2(drive,) start, count, buf)
  97         #define storage_write_sectors(drive, start, count, buf) sd_write_sectors(IF_MD2(drive,) start, count, buf)
  98         #ifdef HAVE_STORAGE_FLUSH
  99             #define storage_flush() (void)0
 100         #endif
 101         #define storage_last_disk_activity() sd_last_disk_activity()
 102         #define storage_spinup_time() 0
 103         #define storage_get_identify() sd_get_identify()
 104
 105         #ifdef STORAGE_GET_INFO
 106             #define storage_get_info(drive, info) sd_get_info(IF_MD2(drive,) info)
 107         #endif
 108         #ifdef HAVE_HOTSWAP
 109             #define storage_removable(drive) sd_removable(IF_MD(drive))
 110             #define storage_present(drive) sd_present(IF_MD(drive))
 111         #endif
 112      #elif (CONFIG_STORAGE & STORAGE_MMC)
 113         #define storage_spindown mmc_spindown
 114         #define storage_sleep mmc_sleep
 115         #define storage_spin mmc_spin
 116
 117         #define storage_enable(on) mmc_enable(on)
 118         #define storage_sleepnow() mmc_sleepnow()
 119         #define storage_disk_is_active() mmc_disk_is_active()
 120         #define storage_soft_reset() (void)0
 121         #define storage_init() mmc_init()
 122         #define storage_read_sectors(drive, start, count, buf) mmc_read_sectors(IF_MD2(drive,) start, count, buf)
 123         #define storage_write_sectors(drive, start, count, buf) mmc_write_sectors(IF_MD2(drive,) start, count, buf)
 124         #ifdef HAVE_STORAGE_FLUSH
 125             #define storage_flush() (void)0
 126         #endif
 127         #define storage_last_disk_activity() mmc_last_disk_activity()
 128         #define storage_spinup_time() 0
 129         #define storage_get_identify() mmc_get_identify()
 130
 131         #ifdef STORAGE_GET_INFO
 132             #define storage_get_info(drive, info) mmc_get_info(IF_MD2(drive,) info)
 133         #endif
 134         #ifdef HAVE_HOTSWAP
 135             #define storage_removable(drive) mmc_removable(IF_MD(drive))
 136             #define storage_present(drive) mmc_present(IF_MD(drive))
 137         #endif
 138     #elif (CONFIG_STORAGE & STORAGE_NAND)
 139         #define storage_spindown nand_spindown
 140         #define storage_sleep nand_sleep
 141         #define storage_spin nand_spin
 142
 143         #define storage_enable(on) (void)0
 144         #define storage_sleepnow() nand_sleepnow()
 145         #define storage_disk_is_active() 0
 146         #define storage_soft_reset() (void)0
 147         #define storage_init() nand_init()
 148         #define storage_read_sectors(drive, start, count, buf) nand_read_sectors(IF_MD2(drive,) start, count, buf)
 149         #define storage_write_sectors(drive, start, count, buf) nand_write_sectors(IF_MD2(drive,) start, count, buf)
 150         #ifdef HAVE_STORAGE_FLUSH
 151             #define storage_flush() nand_flush()
 152         #endif
 153         #define storage_last_disk_activity() nand_last_disk_activity()
 154         #define storage_spinup_time() 0
 155         #define storage_get_identify() nand_get_identify()
 156
 157         #ifdef STORAGE_GET_INFO
 158             #define storage_get_info(drive, info) nand_get_info(IF_MD2(drive,) info)
 159         #endif
 160         #ifdef HAVE_HOTSWAP
 161             #define storage_removable(drive) nand_removable(IF_MD(drive))
 162             #define storage_present(drive) nand_present(IF_MD(drive))
 163         #endif
 164     #elif (CONFIG_STORAGE & STORAGE_RAMDISK)
 165         #define storage_spindown ramdisk_spindown
 166         #define storage_sleep ramdisk_sleep
 167         #define storage_spin ramdisk_spin
 168
 169         #define storage_enable(on) (void)0
 170         #define storage_sleepnow() ramdisk_sleepnow()
 171         #define storage_disk_is_active() 0
 172         #define storage_soft_reset() (void)0
 173         #define storage_init() ramdisk_init()
 174         #define storage_read_sectors(drive, start, count, buf) ramdisk_read_sectors(IF_MD2(drive,) start, count, buf)
 175         #define storage_write_sectors(drive, start, count, buf) ramdisk_write_sectors(IF_MD2(drive,) start, count, buf)
 176         #ifdef HAVE_STORAGE_FLUSH
 177             #define storage_flush() (void)0
 178         #endif
 179         #define storage_last_disk_activity() ramdisk_last_disk_activity()
 180         #define storage_spinup_time() 0
 181         #define storage_get_identify() ramdisk_get_identify()
 182
 183         #ifdef STORAGE_GET_INFO
 184             #define storage_get_info(drive, info) ramdisk_get_info(IF_MD2(drive,) info)
 185         #endif
 186         #ifdef HAVE_HOTSWAP
 187             #define storage_removable(drive) ramdisk_removable(IF_MD(drive))
 188             #define storage_present(drive) ramdisk_present(IF_MD(drive))
 189         #endif
 190     #else
 191         //#error No storage driver!
 192     #endif
 193 #else /* NOT CONFIG_STORAGE_MULTI and NOT SIMULATOR*/
 194
 195 /* Simulator and multi-driver use normal functions */
 196
 197 void storage_enable(bool on);
 198 void storage_sleep(void);
 199 void storage_sleepnow(void);
 200 bool storage_disk_is_active(void);
 201 int storage_soft_reset(void);
 202 int storage_init(void);
 203 int storage_read_sectors(int drive, unsigned long start, int count, void* buf);
 204 int storage_write_sectors(int drive, unsigned long start, int count, const void* buf);
 205 int storage_flush(void);
 206 void storage_spin(void);
 207 void storage_spindown(int seconds);
 208 long storage_last_disk_activity(void);
 209 int storage_spinup_time(void);
 210 int storage_num_drives(void);
 211 #ifdef STORAGE_GET_INFO
 212 void storage_get_info(int drive, struct storage_info *info);
 213 #endif
 214 #ifdef HAVE_HOTSWAP
 215 bool storage_removable(int drive);
 216 bool storage_present(int drive);
 217 #endif
 218
 219 #endif /* NOT CONFIG_STORAGE_MULTI and NOT SIMULATOR*/
 220 #endif