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_MULTIVOLUME 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 #ifndef SIMULATOR
  55     #ifndef CONFIG_STORAGE_MULTI
  56     /* storage_spindown, storage_sleep and storage_spin are passed as
  57      * pointers, which doesn't work with argument-macros.
  58      */
  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_MV2(drive,) start, count, buf)
  71             #define storage_write_sectors(drive, start, count, buf) ata_write_sectors(IF_MV2(drive,) start, count, buf)
  72             #define storage_last_disk_activity() ata_last_disk_activity()
  73             #define storage_spinup_time() ata_spinup_time()
  74             #define storage_get_identify() ata_get_identify()
  75
  76             #ifdef STORAGE_GET_INFO
  77                 #define storage_get_info(drive, info) ata_get_info(IF_MV2(drive,) info)
  78             #endif
  79             #ifdef HAVE_HOTSWAP
  80                 #define storage_removable(drive) ata_removable(IF_MV(drive))
  81                 #define storage_present(drive) ata_present(IF_MV(drive))
  82             #endif
  83         #elif (CONFIG_STORAGE & STORAGE_SD)
  84             #define storage_spindown sd_spindown
  85             #define storage_sleep sd_sleep
  86             #define storage_spin sd_spin
  87
  88             #define storage_enable(on) sd_enable(on)
  89             #define storage_sleepnow() sd_sleepnow()
  90             #define storage_disk_is_active() 0
  91             #define storage_soft_reset() (void)0
  92             #define storage_init() sd_init()
  93             #define storage_close() sd_close()
  94             #define storage_read_sectors(drive, start, count, buf) sd_read_sectors(IF_MV2(drive,) start, count, buf)
  95             #define storage_write_sectors(drive, start, count, buf) sd_write_sectors(IF_MV2(drive,) start, count, buf)
  96             #define storage_last_disk_activity() sd_last_disk_activity()
  97             #define storage_spinup_time() 0
  98             #define storage_get_identify() sd_get_identify()
  99
 100             #ifdef STORAGE_GET_INFO
 101                 #define storage_get_info(drive, info) sd_get_info(IF_MV2(drive,) info)
 102             #endif
 103             #ifdef HAVE_HOTSWAP
 104                 #define storage_removable(drive) sd_removable(IF_MV(drive))
 105                 #define storage_present(drive) sd_present(IF_MV(drive))
 106             #endif
 107          #elif (CONFIG_STORAGE & STORAGE_MMC)
 108             #define storage_spindown mmc_spindown
 109             #define storage_sleep mmc_sleep
 110             #define storage_spin mmc_spin
 111
 112             #define storage_enable(on) mmc_enable(on)
 113             #define storage_sleepnow() mmc_sleepnow()
 114             #define storage_disk_is_active() mmc_disk_is_active()
 115             #define storage_soft_reset() (void)0
 116             #define storage_init() mmc_init()
 117             #define storage_close() mmc_close()
 118             #define storage_read_sectors(drive, start, count, buf) mmc_read_sectors(IF_MV2(drive,) start, count, buf)
 119             #define storage_write_sectors(drive, start, count, buf) mmc_write_sectors(IF_MV2(drive,) start, count, buf)
 120             #define storage_last_disk_activity() mmc_last_disk_activity()
 121             #define storage_spinup_time() 0
 122             #define storage_get_identify() mmc_get_identify()
 123
 124             #ifdef STORAGE_GET_INFO
 125                 #define storage_get_info(drive, info) mmc_get_info(IF_MV2(drive,) info)
 126             #endif
 127             #ifdef HAVE_HOTSWAP
 128                 #define storage_removable(drive) mmc_removable(IF_MV(drive))
 129                 #define storage_present(drive) mmc_present(IF_MV(drive))
 130             #endif
 131         #elif (CONFIG_STORAGE & STORAGE_NAND)
 132             #define storage_spindown nand_spindown
 133             #define storage_sleep nand_sleep
 134             #define storage_spin nand_spin
 135
 136             #define storage_enable(on) (void)0
 137             #define storage_sleepnow() nand_sleepnow()
 138             #define storage_disk_is_active() 0
 139             #define storage_soft_reset() (void)0
 140             #define storage_init() nand_init()
 141             #define storage_close() nand_close()
 142             #define storage_read_sectors(drive, start, count, buf) nand_read_sectors(IF_MV2(drive,) start, count, buf)
 143             #define storage_write_sectors(drive, start, count, buf) nand_write_sectors(IF_MV2(drive,) start, count, buf)
 144             #define storage_last_disk_activity() nand_last_disk_activity()
 145             #define storage_spinup_time() 0
 146             #define storage_get_identify() nand_get_identify()
 147
 148             #ifdef STORAGE_GET_INFO
 149                 #define storage_get_info(drive, info) nand_get_info(IF_MV2(drive,) info)
 150             #endif
 151             #ifdef HAVE_HOTSWAP
 152                 #define storage_removable(drive) nand_removable(IF_MV(drive))
 153                 #define storage_present(drive) nand_present(IF_MV(drive))
 154             #endif
 155         #elif (CONFIG_STORAGE & STORAGE_RAMDISK)
 156             #define storage_spindown ramdisk_spindown
 157             #define storage_sleep ramdisk_sleep
 158             #define storage_spin ramdisk_spin
 159
 160             #define storage_enable(on) (void)0
 161             #define storage_sleepnow() ramdisk_sleepnow()
 162             #define storage_disk_is_active() 0
 163             #define storage_soft_reset() (void)0
 164             #define storage_init() ramdisk_init()
 165             #define storage_close() ramdisk_close()
 166             #define storage_read_sectors(drive, start, count, buf) ramdisk_read_sectors(IF_MV2(drive,) start, count, buf)
 167             #define storage_write_sectors(drive, start, count, buf) ramdisk_write_sectors(IF_MV2(drive,) start, count, buf)
 168             #define storage_last_disk_activity() ramdisk_last_disk_activity()
 169             #define storage_spinup_time() 0
 170             #define storage_get_identify() ramdisk_get_identify()
 171
 172             #ifdef STORAGE_GET_INFO
 173                 #define storage_get_info(drive, info) ramdisk_get_info(IF_MV2(drive,) info)
 174             #endif
 175             #ifdef HAVE_HOTSWAP
 176                 #define storage_removable(drive) ramdisk_removable(IF_MV(drive))
 177                 #define storage_present(drive) ramdisk_present(IF_MV(drive))
 178             #endif
 179         #else
 180             //#error No storage driver!
 181         #endif
 182     #else /* NOT CONFIG_STORAGE_MULTI */
 183
 184     /* TODO : implement multi-driver here */
 185     #error Multi-driver storage not implemented yet
 186
 187     #endif /* NOT CONFIG_STORAGE_MULTI */
 188 #else /*NOT SIMULATOR */
 189 void storage_enable(bool on);
 190 void storage_sleep(void);
 191 void storage_sleepnow(void);
 192 bool storage_disk_is_active(void);
 193 int storage_soft_reset(void);
 194 int storage_init(void);
 195 void storage_close(void);
 196 int storage_read_sectors(int drive, unsigned long start, int count, void* buf);
 197 int storage_write_sectors(int drive, unsigned long start, int count, const void* buf);
 198 void storage_spin(void);
 199 void storage_spindown(int seconds);
 200 long storage_last_disk_activity(void);
 201 int storage_spinup_time(void);
 202 #ifdef STORAGE_GET_INFO
 203 void storage_get_info(int drive, struct storage_info *info);
 204 #endif
 205 #ifdef HOTSWAP
 206 bool storage_removable(int drive);
 207 bool storage_present(int drive);
 208 #endif
 209 #endif/*NOT SIMULATOR */
 210 #endif