Changes between Version 2 and Version 3 of nic_driver

Timestamp:

Oct 21, 2014, 11:32:13 AM (10 years ago)

Author:

alain

Comment:

--

nic_driver

@@ -7 +7 @@
 This component is a multi-channels, giga-bit Ethernet network controller. It is an ''external'', non replicated peripheral. 
 
- * The ''_nic_sync_write()'' and ''_nic_sync_read()'' functions use a ''memcpy'' strategy to transfer a flow of packets between a chained buffer in kernel space and the NIC internal chained buffer. They are blocking until completion of the transfer.
+ * The ''_nic_sync_send()'' and ''_nic_sync_receive()'' functions use a ''physical_memcpy()''  to transfer data between a single container (4 Kbytes buffer) in user space and the NIC internal chained buffer. They are blocking until completion of the transfer. One NIC channel must be allocated to the calling task in the mapping.
+ 
+ * The ''_nic_cma_start_send()'' and ''_nic_cma_start_receive()'' functions use the ''vci_chbuf_dma'' component to transfer a flow of packets between a chained buffer in kernel space and the NIC internal chained buffer. They are non blocking. One NIC channel and two CMA channels (TX  and RX) must be allocated to the calling task in the mapping. 
 
- * The ''_nic_cma_start()'' and ''_nic_cma_stop()'' functions use the ''vci_chbuf_dma'' component to transfer a flow of packets between a chained buffer in kernel space and the NIC internal chained buffer. They are non blocking. In this case, one NIC channel and two CMA channels must be allocated to the task in the mapping_info data structure.
-
-The SEG_NIC_BASE address must be defined in the hard_config.h file.
+The SEG_NIC_BASE address and the NB_NIC_CHANNELS parameter must be defined in the hard_config.h file.
 
 The addressable registers map is defined [source:soft/giet_vm/giet_drivers/nic_driver.h here].
 
-WARNING : All these functions are not completely specified yet.
+WARNING : The CMA functions are not implemented yet.
 
- 
+== __Initialization Functions__ ==
 
- === unsigned int '''_nic_sync_write'''( ) ===
+ === void '''_nic_global_init'''( unsigned int channels, unsigned int vis, unsigned int bc_enable, unsigned int bypass_enable ) ===
+This function initializes the NIC global registers.
+ * channels : number of active channels 
+ * vis : bit vector(one bit per active channel)
+ * bc_enable : broadcast packets accepted if non zero
+ * bypass_enable : TX -> RX bypass supported if non zero
+This function is used only by the boot code.
+
+ === void '''_nic_channel_init'''( unsigned int index,  unsigned int mac4,  unsigned int mac2 ) ===
+This function initializes the NIC registers for a given channel.
+ * index : channel index
+ * mac4 : 32 LSB bits of the MAC address.
+ * mac2 : 16 MSB bits of the MAC address.
+This function is used only by the boot code.
+
+== __Functions using a physical_memcpy__ ==
+
+ === void '''_nic_sync_send'''( void* vbase ) ===
+This blocking function uses a physical_memcpy() to transfer one container (4 Kbytes) from a single user buffer to the NIC. The ''vbase'' argument is the user buffer virtual base address.
+
+ === void '''_nic_sync_receive'''( void* vbase ) ===
+This blocking function uses a physical_memcpy() to transfer one container (4 Kbytes) from the NIC to a single user buffer. The ''vbase'' argument is the user buffer virtual base address.
+
+== __Functions using the chained buffer DMA__ ==
+
+ === void '''_nic_cma_start_send'''( ) ===
+To be defined... 
+
+ === void '''_nic_cma_stop_send'''( ) ===
 To be defined...
 
- === unsigned int '''_nic_sync_read'''( ) ===
+=== void '''_nic_cma_start_receive'''( ) ===
+To be defined... 
+
+ === void '''_nic_cma_stop_receive'''( ) ===
 To be defined...
 
- === unsigned int '''_nic_cma_start'''( ) ===
-To be defined... 
-
- === unsigned int '''_nic_cma_stop'''( ) ===
-To be defined...
+== __ Interrupt Service Routines__ ==
 
  === void '''_nic_rx_isr'''( unsigned int irq_type,  unsigned int irq_id,  unsigned int channel ) ===