Changeset 437 for soft/giet_vm/giet_drivers/sdc_driver.h

Timestamp:

Nov 3, 2014, 10:53:00 AM (10 years ago)

Author:

alain

Message:

Introducing dynamic allocation of peripheral channel(TTY, NIC, TIM, CMA)
Removint the ICU driver : ICU component not supported anymore.
Removing the FBF driver.

File:

• soft/giet_vm/giet_drivers/sdc_driver.h (modified) (4 diffs)

soft/giet_vm/giet_drivers/sdc_driver.h

@@ -5 +5 @@
 // Copyright (c) UPMC-LIP6
 ///////////////////////////////////////////////////////////////////////////////////
+
 #ifndef _GIET_SDC_DRIVER_H_
 #define _GIET_SDC_DRIVER_H_
@@ -36 +37 @@
 };
 
+///////////////////////////////////////////////////////////////////////////////
+// This function initializes the SPI controller and call sdc_open to
+// initialize  the SD card
+// - channel: channel to initialize (only channel 0 supported)
+// Returns 0 if success, other value if failure
+///////////////////////////////////////////////////////////////////////////////
 unsigned int _sdc_init();
 
+///////////////////////////////////////////////////////////////////////////////
+// Transfer data from the block device to a memory buffer. 
+// - mode     : BOOT / KERNEL / USER
+// - lba      : first block index on the block device
+// - buffer   : base address of the memory buffer (must be word aligned)
+// - count    : number of blocks to be transfered.
+// Returns 0 if success, > 0 if error.
+///////////////////////////////////////////////////////////////////////////////
 unsigned int _sdc_read( unsigned int mode,
                         unsigned int lba,
@@ -44 +59 @@
 
 
+///////////////////////////////////////////////////////////////////////////////
+// Transfer data from memory buffer to SD card device. 
+// - mode     : BOOT / KERNEL / USER
+// - lba      : destination first block index on the SD card
+// - buffer   : base address of the memory buffer (must be word aligned)
+// - count    : number of blocks to be transfered.
+// Returns 0 if success, > 0 if error.
+// WARNING: The _sdc_write() is not implemented yet.
+///////////////////////////////////////////////////////////////////////////////
 unsigned int _sdc_write( unsigned int mode,
                          unsigned int lba,
@@ -49 +73 @@
                          unsigned int count);
 
+///////////////////////////////////////////////////////////////////////////////
+// This function should not be called for the SDC card.
+///////////////////////////////////////////////////////////////////////////////
 unsigned int _sdc_get_status();
 
+///////////////////////////////////////////////////////////////////////////////
+// Returns the block size in bytes of the SD card.
+///////////////////////////////////////////////////////////////////////////////
 unsigned int _sdc_get_block_size();