Fix documentation and tests

Author: leventelist

src/il2p_codec.c

@@ -40,6 +40,34 @@
  *--------------------------------------------------------------*/
 
 
+static int il2p_check_crc(unsigned char *payload, int payload_length, unsigned char *coded_crc);
+static int il2p_generate_crc(unsigned char *coded_crc, unsigned char *payload, int payload_length);
+
+#define IL2P_NIBLE_MASK 0x0f
+#define IL2P_DECODE_MASK 0x7f
+
+// local variables
+
+static uint8_t encode_table[16] = { 0x0, 0x71, 0x62, 0x13, 0x54, 0x25, 0x36, 0x47, 0x38, 0x49, 0x5a, 0x2b, 0x6c, 0x1d, 0x0e, 0x7f };
+
+static uint8_t decode_table[128] = { 0x0, 0x0, 0x0, 0x3, 0x0, 0x5, 0xe, 0x7,
+																			0x0, 0x9, 0xe, 0xb, 0xe, 0xd, 0xe, 0xe,
+																			0x0, 0x3, 0x3, 0x3, 0x4, 0xd, 0x6, 0x3,
+																			0x8, 0xd, 0xa, 0x3, 0xd, 0xd, 0xe, 0xd,
+																			0x0, 0x5, 0x2, 0xb, 0x5, 0x5, 0x6, 0x5,
+																			0x8, 0xb, 0xb, 0xb, 0xc, 0x5, 0xe, 0xb,
+																			0x8, 0x1, 0x6, 0x3, 0x6, 0x5, 0x6, 0x6,
+																			0x8, 0x8, 0x8, 0xb, 0x8, 0xd, 0x6, 0xf,
+																			0x0, 0x9, 0x2, 0x7, 0x4, 0x7, 0x7, 0x7,
+																			0x9, 0x9, 0xa, 0x9, 0xc, 0x9, 0xe, 0x7,
+																			0x4, 0x1, 0xa, 0x3, 0x4, 0x4, 0x4, 0x7,
+																			0xa, 0x9, 0xa, 0xa, 0x4, 0xd, 0xa, 0xf,
+																			0x2, 0x1, 0x2, 0x2, 0xc, 0x5, 0x2, 0x7,
+																			0xc, 0x9, 0x2, 0xb, 0xc, 0xc, 0xc, 0xf,
+																			0x1, 0x1, 0x2, 0x1, 0x4, 0x1, 0x6, 0xf,
+																			0x8, 0x1, 0xa, 0xf, 0xc, 0xf, 0xf, 0xf };
+
+
 /*-------------------------------------------------------------
  *
  * Name:	il2p_encode_frame
@@ -52,6 +80,8 @@
  *
  *		max_fec	- 1 to send maximum FEC size rather than automatic.
  *
+ * 		use_crc - 1 to use CRC for the payload.
+ *
  * Outputs:	iout	- Encoded result, excluding the 3 byte sync word.
  *			  Caller should provide  IL2P_MAX_PACKET_SIZE  bytes.
  *
@@ -69,34 +99,6 @@
  *
  *--------------------------------------------------------------*/
 
-static int il2p_check_crc(unsigned char *payload, int payload_length, unsigned char *coded_crc);
-static int il2p_generate_crc(unsigned char *coded_crc, unsigned char *payload, int payload_length);
-
-#define IL2P_NIBLE_MASK 0x0f
-#define IL2P_DECODE_MASK 0x7f
-
-// local variables
-
-static uint8_t encode_table[16] = { 0x0, 0x71, 0x62, 0x13, 0x54, 0x25, 0x36, 0x47, 0x38, 0x49, 0x5a, 0x2b, 0x6c, 0x1d, 0x0e, 0x7f };
-
-static uint8_t decode_table[128] = { 0x0, 0x0, 0x0, 0x3, 0x0, 0x5, 0xe, 0x7,
-																			0x0, 0x9, 0xe, 0xb, 0xe, 0xd, 0xe, 0xe,
-																			0x0, 0x3, 0x3, 0x3, 0x4, 0xd, 0x6, 0x3,
-																			0x8, 0xd, 0xa, 0x3, 0xd, 0xd, 0xe, 0xd,
-																			0x0, 0x5, 0x2, 0xb, 0x5, 0x5, 0x6, 0x5,
-																			0x8, 0xb, 0xb, 0xb, 0xc, 0x5, 0xe, 0xb,
-																			0x8, 0x1, 0x6, 0x3, 0x6, 0x5, 0x6, 0x6,
-																			0x8, 0x8, 0x8, 0xb, 0x8, 0xd, 0x6, 0xf,
-																			0x0, 0x9, 0x2, 0x7, 0x4, 0x7, 0x7, 0x7,
-																			0x9, 0x9, 0xa, 0x9, 0xc, 0x9, 0xe, 0x7,
-																			0x4, 0x1, 0xa, 0x3, 0x4, 0x4, 0x4, 0x7,
-																			0xa, 0x9, 0xa, 0xa, 0x4, 0xd, 0xa, 0xf,
-																			0x2, 0x1, 0x2, 0x2, 0xc, 0x5, 0x2, 0x7,
-																			0xc, 0x9, 0x2, 0xb, 0xc, 0xc, 0xc, 0xf,
-																			0x1, 0x1, 0x2, 0x1, 0x4, 0x1, 0x6, 0xf,
-																			0x8, 0x1, 0xa, 0xf, 0xc, 0xf, 0xf, 0xf };
-
-
 int il2p_encode_frame (packet_t pp, int max_fec, unsigned char *iout, int use_crc)
 {
 
@@ -200,6 +202,7 @@ int il2p_encode_frame (packet_t pp, int max_fec, unsigned char *iout, int use_cr
  *		applied first so we would know how much to collect for the payload.
  *
  * Inputs:	irec	- Received IL2P frame excluding the 3 byte sync word.
+ *          use_crc - 1 to chec CRC for the payload.
  *
  * Future Out:	Number of symbols corrected.
  *
@@ -226,6 +229,7 @@ packet_t il2p_decode_frame (unsigned char *irec, int use_crc)
  *
  * Inputs:	uhdr 		- Received header after FEC and descrambling.
  *		epayload	- Encoded payload.
+ *		use_crc	- 1 to check CRC for the payload.
  *
  * In/Out:	symbols_corrected - Symbols (bytes) corrected in the header.
  *				  Should be 0 or 1 because it has 2 parity symbols.

src/il2p_send.c

@@ -50,6 +50,8 @@ static void send_bit (int chan, int b, int polarity);
  *		max_fec	- 1 to force 16 parity symbols for each payload block.
  *			  0 for automatic depending on block size.
  *
+ * 		use_crc - 1 to use CRC for the payload.
+ *
  *		polarity - 0 for normal.  1 to invert signal.
  *			   2 special case for testing - introduce some errors to test FEC.
  *

src/il2p_test.c

@@ -288,8 +288,9 @@ static void test_payload(void)
 	for (int max_fec = 0; max_fec <= 1; max_fec++) {
 	    for (int payload_length = 1; payload_length <= IL2P_MAX_PAYLOAD_SIZE; payload_length++) {
 	        //dw_printf ("\n--------- max_fec = %d, payload_length = %d\n", max_fec, payload_length);
+					unsigned char *next = NULL;
 	        unsigned char encoded[IL2P_MAX_ENCODED_PAYLOAD_SIZE];
-	        int k = il2p_encode_payload (original_payload, payload_length, max_fec, encoded);
+	        int k = il2p_encode_payload (original_payload, payload_length, max_fec, encoded, &next);
 
 	        //dw_printf ("payload length %d %s -> %d\n", payload_length, max_fec ? "M" : "", k);
 	        assert (k > payload_length && k <= IL2P_MAX_ENCODED_PAYLOAD_SIZE);
@@ -298,7 +299,7 @@ static void test_payload(void)
 
 	        unsigned char extracted[IL2P_MAX_PAYLOAD_SIZE];
 	        int symbols_corrected = 0;
-		int e = il2p_decode_payload (encoded, payload_length, max_fec, extracted, &symbols_corrected);
+		int e = il2p_decode_payload (encoded, payload_length, max_fec, extracted, &symbols_corrected, &next);
 	        //dw_printf ("e = %d, payload_length = %d\n", e, payload_length);
 		assert (e == payload_length);
 
@@ -584,7 +585,7 @@ static void test_example_headers()
 
 	int max_fec = 0;
 	unsigned char iout[IL2P_MAX_PACKET_SIZE];
-	e = il2p_encode_frame (pp, max_fec, iout);
+	e = il2p_encode_frame (pp, max_fec, iout, 1);
 
 	//dw_printf ("expected for example 3:\n");
 	//fx_hex_dump(complete3, sizeof(complete3));
@@ -616,11 +617,11 @@ static void enc_dec_compare (packet_t pp1)
 
 	unsigned char encoded[IL2P_MAX_PACKET_SIZE];
 	int enc_len;
-	enc_len = il2p_encode_frame (pp1, max_fec, encoded);
+	enc_len = il2p_encode_frame (pp1, max_fec, encoded, 1);
 	assert (enc_len >= 0);
 
 	packet_t pp2;
-	pp2 = il2p_decode_frame (encoded);
+	pp2 = il2p_decode_frame (encoded, 1);
 	assert (pp2 != NULL);
 
 // Is it the same after encoding to IL2P and then decoding?
@@ -851,7 +852,7 @@ static void decode_bitstream(void)
 	while ( (ch = fgetc(fp)) != EOF) {
 
 	  if (ch == '0' || ch == '1') {
-	    il2p_rec_bit (0, 0, 0, ch - '0');
+	    il2p_rec_bit (0, 0, 0, ch - '0', 1);
 	  }
 	}
 	fclose(fp);
@@ -918,11 +919,11 @@ static void test_serdes (void)
 
 	    for (max_fec = 0; max_fec <= 1; max_fec++) {
 	        for (polarity = 0; polarity <= 2; polarity++) {	// 2 means throw in some errors.
- 	            int num_bits_sent = il2p_send_frame (chan, pp, max_fec, polarity);
+ 	            int num_bits_sent = il2p_send_frame (chan, pp, max_fec, polarity, 1);
 	            dw_printf ("%d bits sent.\n", num_bits_sent);
 
 	            // Need extra bit at end to flush out state machine.
-	            il2p_rec_bit (0, 0, 0, 0);
+	            il2p_rec_bit (0, 0, 0, 0, 1);
 	        }
 	    }
 	    ax25_delete(pp);
@@ -938,7 +939,7 @@ static void test_serdes (void)
 
 void tone_gen_put_bit (int chan, int data)
 {
-	il2p_rec_bit (chan, 0, 0, data);
+	il2p_rec_bit (chan, 0, 0, data, 1);
 }
 
 // This is called when a complete frame has been deserialized.