summaryrefslogtreecommitdiff
path: root/cesar/test_general
diff options
context:
space:
mode:
authorlaranjeiro2008-04-23 14:14:45 +0000
committerlaranjeiro2008-04-23 14:14:45 +0000
commit642567312f9d35b7fcc9b46fd4064b09d2ad4a1d (patch)
treec6695329de78e1640dfdbd5d8374e587b1c81bb2 /cesar/test_general
parentc9db80ad5b24ac2dea8944486014ebf661964a11 (diff)
cl-sar-pbproc: Added some documentation for the test.
git-svn-id: svn+ssh://pessac/svn/cesar/trunk@1888 017c9cb6-072f-447c-8318-d5b54f68fe89
Diffstat (limited to 'cesar/test_general')
-rw-r--r--cesar/test_general/integration/cl-sar-pbproc/doc/test1.txt131
-rw-r--r--cesar/test_general/integration/cl-sar-pbproc/test1.py (renamed from cesar/test_general/integration/cl-sar-pbproc/src/Maximus.py)0
2 files changed, 131 insertions, 0 deletions
diff --git a/cesar/test_general/integration/cl-sar-pbproc/doc/test1.txt b/cesar/test_general/integration/cl-sar-pbproc/doc/test1.txt
new file mode 100644
index 0000000000..6995b1b657
--- /dev/null
+++ b/cesar/test_general/integration/cl-sar-pbproc/doc/test1.txt
@@ -0,0 +1,131 @@
+= CL - SAR - PBProc =
+
+This will test the fonctionalities of the Convergence Layer with the SAR and
+the PBProc.
+
+The convergence layer needs to know the mac address of the station to send
+some packets.
+
+== Acronyms ==
+
+ * CP : Control Plane.
+ * TEI : Terminal Equipment Identifier.
+ * snid : Short Network Identifier.
+
+== Station Mac address configuration ==
+
+For example the station 1 will have the Mac address "23:45:67:89:AB:CD",
+
+{{{
+sta1_mac = 0x23456789abcd
+sta1_mac_str = pack ('>Q', sta1_mac)[2:8]
+}}}
+
+The second line allow the mac address to be converted into the opposite
+address to simulated the real mac address which will be read by the Leon
+processor.
+
+== Function Calls ==
+
+=== fc_station_init_config ===
+
+To configure the station.
+
+Parameters :
+ * snid : The snid of the station.
+ * tei : the station tei.
+ * auto_sched : To create automatically the schedules for the CA.
+
+=== fc_station_discover ===
+
+Use to provide to the station its own mac address and teim and the others
+station's mac addresses and TEIs.
+
+Parameters:
+ * qte : the quantity of data.
+ * teix : The station tei, x correspond to the number, 0 is reserved for the
+station's TEI.
+ * macx : The station mac address, x correspond to the number, 0 is reserved
+for the station's mac address.
+
+=== fc_station_link_add ===
+
+Add a link to the station i.e. create a MFS in the mac store.
+
+Parameters :
+ * type : TX/RX MFS.
+ * bcast : Broadcast MFS
+ * mme : MME MFS.
+ * lid : The lid of the MFS.
+ * tei : The source/destination station.
+
+=== fc_cl_mme_buffer_add ===
+
+Request the CL to send a MME buffer to the CP. (The CP was stubbed in this
+test).
+
+=== fc_cl_data_buffer_add ===
+
+Add a data buffer for the SAR to reassembly some Mac Frames.
+
+=== fc_cl_data_send ===
+
+Send a data to a station identifier by its mac address (Sends a real Ethernet
+packet).
+
+Parameters:
+ * length : The Ethernet packet length.
+ * buffer : The data to send.
+
+=== fc_cl_mme_send ===
+
+Sends a MME to a station.
+
+Parameters :
+ * length : The MME length.
+ * buffer : The data to send.
+
+=== fc_cp_mme_send_as_mme ===
+
+Simulates the CP sending a MME.
+
+Parameters:
+ * length : The MME length.
+ * tei : the destination TEI.
+ * bcast : the kind of link.
+ * buffer : The data to send.
+
+=== fc_station_link_remove ===
+
+Remove a link from the station (and from the mac store).
+
+Parameters :
+ * type : TX/RX MFS.
+ * bcast : Broadcast MFS
+ * mme : MME MFS.
+ * lid : The lid of the MFS.
+ * tei : The source/destination station.
+
+=== fc_sar_print_trace ===
+
+To print the SAR traces taken during the test.
+To see the SAR traces add a Config file to the make directory with the
+following line.
+
+{{{
+CONFIG_TRACE=y
+}}}
+
+And compile again the test.
+
+=== fc_cl_print_trace ===
+
+To print the CL traces taken during the test.
+To see the CL traces add a Config file to the make directory with the
+following line.
+
+{{{
+CONFIG_TRACE=y
+}}}
+
+And compile again the test.
diff --git a/cesar/test_general/integration/cl-sar-pbproc/src/Maximus.py b/cesar/test_general/integration/cl-sar-pbproc/test1.py
index bc2d703895..bc2d703895 100644
--- a/cesar/test_general/integration/cl-sar-pbproc/src/Maximus.py
+++ b/cesar/test_general/integration/cl-sar-pbproc/test1.py