[wiki:Component SocLib Components General Index] 

= !VciRam =

== 1) Functional Description ==

This VCI target is an embedded SRAM controller. This hardware component handles
independent memory segments. Each segment is defined by a base address and a size (number of bytes).
Both the base and the size parameters must be multiple of 4.
The segments allocated to a given instance of this component are defined in the [wiki:Component/MappingTable Mapping Table].

Each segment is implemented as a dynamically allocated array in the constructor.

A !MultiRam will initialize its segments from a binary if an
[wiki:Component/ElfLoader ElfLoader] is attached to it.

== 2) Component definition & usage ==

source:trunk/soclib/soclib/module/internal_component/vci_ram/caba/metadata/vci_ram.sd

See [wiki:SoclibCc/VciParameters SoclibCc/VciParameters]
{{{
Uses( 'vci_ram', **vci_parameters )
}}}

== 3) CABA Implementation ==
 
=== CABA sources ===

 * interface : source:trunk/soclib/soclib/module/internal_component/vci_ram/caba/source/include/vci_ram.h
 * implementation : source:trunk/soclib/soclib/module/internal_component/vci_ram/caba/source/src/vci_ram.cpp

=== CABA Constructor parameters ===

 * Uninitialized !VciRam
{{{
VciRam(
     sc_module_name name,                     // Instance name
     const soclib::common::IntTab &index,     //  Target index
     const soclib::common::MappingTable &mt)  // Mapping Table
}}}

 * Elf-Initialized !VciRam
You may load a binary file, by creating a loader:
{{{
soclib::common::ElfLoader loader( "a.out" );
VciRam(
     sc_module_name name,                     // Instance name
     const soclib::common::IntTab &index,     //  Target index
     const soclib::common::MappingTable &mt,  // Mapping Table
     soclib::common::ElfLoader &loader); // Loader
}}}
On reset, any loadable segment in ELF file will be reloaded
.
=== CABA Ports ===

 * sc_in<bool> '''p_resetn''' : hardware reset
 * sc_in<bool> '''p_clk''' :  clock
 * soclib::common::!VciTarget<vci_param> '''p_vci''' : The VCI port


== 4)  TLM-T Implementation ==

=== TLM-T sources ===

 * interface : source:trunk/soclib/soclib/module/internal_component/vci_ram/tlmt/source/include/vci_ram.h
 * implementation : source:trunk/soclib/soclib/module/internal_component/vci_ram/tlmt/source/src/vci_ram.cpp

=== TLM-T Constructor parameters ===
{{{
VciRam(
     sc_module_name name,                     // Instance name
     const soclib::common::IntTab &index,     // Target index
     const soclib::common::MappingTable &mt,  // Mapping Table
     soclib::common::ElfLoader &loader);      // Loader
}}}

=== TLM-T Ports ===

 * soclib::tlmt::!VciTarget<vci_param> '''p_vci''' : The VCI port