Changeset 437 for soft/giet_vm/giet_drivers/hba_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/hba_driver.h (modified) (4 diffs)

soft/giet_vm/giet_drivers/hba_driver.h

@@ -5 +5 @@
 // Copyright (c) UPMC-LIP6
 ///////////////////////////////////////////////////////////////////////////////////
+// The hba_driver.c and hba_driver.h files are part ot the GIET-VM kernel.
+// This driver supports the SocLib VciMultiAhci component, that is a multi-channels,
+// block oriented, external storage contrÃŽler, respecting the AHCI standard.
+//
+// The SEG_IOC_BASE virtual address must be defined in the hard_config.h file.
+//////////////////////////////////////////////////////////////////////////////////
 
 #ifndef _GIET_HBA_DRIVERS_H_
@@ -94 +100 @@
 
 ///////////////////////////////////////////////////////////////////////////////////
-// HBA device access functions  (vci_hba)
+//              access functions  
 ///////////////////////////////////////////////////////////////////////////////////
 
+///////////////////////////////////////////////////////////////////////////////////
+// This function initializes for a given channel
+// - the HBA hardware registers,
+// - the command list pointer,
+// - the command lists physical addresse,
+// - the command tables physical addresses array,
+///////////////////////////////////////////////////////////////////////////////////
 extern unsigned int _hba_init ( unsigned int channel ); 
 
+///////////////////////////////////////////////////////////////////////////////////
+// This function register a write command in Command List and Command Table
+// for a single physical buffer, and updates the HBA_PXCI register.
+// Returns 0 if success, > 0 if error.
+///////////////////////////////////////////////////////////////////////////////////
 extern unsigned int _hba_write( unsigned int channel,     // channel index
                                 unsigned int mode,        // BOOT / KERNEL / USER
@@ -105 +123 @@
                                 unsigned int count );     // number of blocs
 
+//////////////////////////////////////////////////////////////////////////////////
+// This function register a read command in Command List and Command Table
+// for a single physical buffer, and updates the HBA_PXCI register.
+// Returns 0 if success, > 0 if error.
+//////////////////////////////////////////////////////////////////////////////////
 extern unsigned int _hba_read ( unsigned int channel,     // channel index
                                 unsigned int mode,        // BOOT / KERNEL / USER
@@ -111 +134 @@
                                 unsigned int count );     // number of blocks
 
+/////////////////////////////////////////////////////////////////////////////////
+// This function returns the block_size of HBA controller
+/////////////////////////////////////////////////////////////////////////////////
+extern unsigned int _hba_get_block_size ();
+
+/////////////////////////////////////////////////////////////////////////////////////
+// This function returns the content of the HBA_PXIS register for a given channel, 
+// and reset this register to acknoledge IRQ.
+// return 0 if success, > 0 if error
+/////////////////////////////////////////////////////////////////////////////////////
 extern unsigned int _hba_get_status( unsigned int   channel );
-
-extern unsigned int _hba_get_block_size ();