Merge pull request drowe67#206 from drowe67/ms-stm32-700e

Add 700E support to the SM1000.

Author: drowe67

src/freedv_700.c

@@ -110,7 +110,7 @@ void freedv_ofdm_voice_open(struct freedv *f, char *mode) {
     ofdm_config = ofdm_get_config_param(f->ofdm);
     f->ofdm_bitsperpacket = ofdm_get_bits_per_packet(f->ofdm);
     f->ofdm_bitsperframe = ofdm_get_bits_per_frame(f->ofdm);
-    f->ofdm_nuwbits = (ofdm_config->ns - 1) * ofdm_config->bps - ofdm_config->txtbits;
+    f->ofdm_nuwbits = ofdm_config->nuwbits;
     f->ofdm_ntxtbits = ofdm_config->txtbits;
 
     f->ldpc = (struct LDPC*)MALLOC(sizeof(struct LDPC));
@@ -140,11 +140,6 @@ void freedv_ofdm_voice_open(struct freedv *f, char *mode) {
 
     f->tx_bits = NULL; /* not used for 700D */
 
-    /* tx BPF off on embedded platforms, as it consumes significant CPU */
-#ifdef __EMBEDDED__
-    ofdm_set_tx_bpf(f->ofdm, 0);
-#endif
-
     f->speech_sample_rate = FREEDV_FS_8000;
     f->codec2 = codec2_create(CODEC2_MODE_700C); assert(f->codec2 != NULL);
     /* should be exactly an integer number of Codec 2 frames in a OFDM modem frame */
@@ -162,6 +157,10 @@ void freedv_ofdm_voice_open(struct freedv *f, char *mode) {
 
     /* attenuate audio 12dB as channel noise isn't that pleasant */
     f->passthrough_gain = 0.25;
+
+    /* should all add up to a complete frame */
+    assert((ofdm_config->ns - 1) * ofdm_config->nc * ofdm_config->bps ==
+	   f->ldpc->coded_bits_per_frame + ofdm_config->txtbits + f->ofdm_nuwbits);
 }
 
 // open function for OFDM data modes, TODO consider moving to a new

src/ldpc_codes.c

@@ -39,7 +39,6 @@ struct LDPC ldpc_codes[] = {
         (uint16_t *)HRA_112_112_H_rows,
         (uint16_t *)HRA_112_112_H_cols
     }
-    #ifndef __EMBEDDED__
     ,
     /* short rate 1/2 code for FreeDV 700E */
     {
@@ -56,6 +55,7 @@ struct LDPC ldpc_codes[] = {
         (uint16_t *)HRA_56_56_H_rows,
         (uint16_t *)HRA_56_56_H_cols
     },
+    #ifndef __EMBEDDED__
 
     /* default Wenet High Alitiude Balloon rate 0.8 code */
     {

src/ofdm.c

@@ -223,6 +223,7 @@ struct OFDM *ofdm_create(const struct OFDM_CONFIG *config) {
     } else {
         /* Use the users values */
 
+
         strcpy(ofdm->mode, config->mode);
         ofdm->nc = config->nc;                    /* Number of carriers */
         ofdm->np = config->np;                    /* Number of modem Frames per Packet */
@@ -251,6 +252,7 @@ struct OFDM *ofdm_create(const struct OFDM_CONFIG *config) {
         ofdm->clip_en = config->clip_en;
         memcpy(ofdm->tx_uw, config->tx_uw, ofdm->nuwbits);
         ofdm->data_mode = config->data_mode;
+
     }
 
     ofdm->rs = (1.0f / ofdm->ts);                 /* Modulation Symbol Rate */
@@ -1918,17 +1920,15 @@ void ofdm_sync_state_machine_data_streaming(struct OFDM *ofdm, uint8_t *rx_uw) {
     }
 
     if (ofdm->sync_state == trial) {
-        if (ofdm->sync_state == trial) {
-            if (ofdm->uw_errors < ofdm->bad_uw_errors) {
-                next_state = synced;
-                ofdm->packet_count = 0;
-                ofdm->modem_frame = ofdm->nuwframes;
-            } else {
-                ofdm->sync_counter++;
+        if (ofdm->uw_errors < ofdm->bad_uw_errors) {
+            next_state = synced;
+            ofdm->packet_count = 0;
+            ofdm->modem_frame = ofdm->nuwframes;
+        } else {
+            ofdm->sync_counter++;
 
-                if (ofdm->sync_counter > ofdm->np) {
-                    next_state = search;
-                }
+            if (ofdm->sync_counter > ofdm->np) {
+                next_state = search;
             }
         }
     }

stm32/CMakeLists.txt

@@ -67,7 +67,7 @@ endif()
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -std=gnu11 -mlittle-endian -mthumb -mthumb-interwork --specs=nano.specs -u_printf_float -mcpu=cortex-m4 -ffunction-sections -fdata-sections -O3")
 
 add_definitions(-DSTM32F40_41xxx -DCORTEX_M4 -D__EMBEDDED__)
-add_definitions(-DFREEDV_MODE_EN_DEFAULT=0 -DFREEDV_MODE_1600_EN=1 -DFREEDV_MODE_700D_EN=1 -DCODEC2_MODE_EN_DEFAULT=0 -DCODEC2_MODE_1300_EN=1 -DCODEC2_MODE_700C_EN=1)
+add_definitions(-DFREEDV_MODE_EN_DEFAULT=0 -DFREEDV_MODE_1600_EN=1 -DFREEDV_MODE_700D_EN=1 -DFREEDV_MODE_700E_EN=1 -DCODEC2_MODE_EN_DEFAULT=0 -DCODEC2_MODE_1300_EN=1 -DCODEC2_MODE_700C_EN=1)
 
 if(FLOAT_TYPE STREQUAL "hard")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsingle-precision-constant -Wdouble-promotion -mfpu=fpv4-sp-d16 -mfloat-abi=hard -D__FPU_PRESENT=1 -D__FPU_USED=1")
@@ -203,6 +203,7 @@ ${CODEC2_SRC}/freedv_data_channel.c
 ${CODEC2_SRC}/newamp1.c
 ${CODEC2_SRC}/mbest.c
 ${CODEC2_SRC}/HRA_112_112.c
+${CODEC2_SRC}/HRA_56_56.c
 ${CODEC2_SRC}/linreg.c
 ${CODEC2_SRC}/mpdecode_core.c
 ${CODEC2_SRC}/ldpc_codes.c

stm32/doc/sm1000_manual.md

@@ -9,7 +9,8 @@
 1. The SELECT button steps through the mode:
    + Analog pass through (ANA)
    + FreeDV 1600 (1600)
-   + FreeDV 700D  (700D)
+   + FreeDV 700D (700D)
+   + FreeDV 700E (700E)
 
 1. Select 1600 mode.
 
@@ -78,7 +79,8 @@ The menu structure looks like this:
         |---> "MODE": Boot-up Operating mode
         |       |---> "ANA":    Analogue mode
         |       |---> "1600":   FreeDV 1600
-        |       '---> "700D":   FreeDV 700D
+        |       |---> "700D":   FreeDV 700D
+        |       '---> "700E":   FreeDV 700E
         |
         |---> "TOT": Time-out timer
         |       |---> "TIME":   Total time-out period (0 == disabled)
@@ -106,7 +108,7 @@ You can program the flash memory on your SM1000 via USB using a Windows or Linux
    2   | July 2019 | [sm1000v2.bin](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v2.bin) |  [sm1000v2.dfu](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v2.dfu) | FreeDV 700D and morse menus
    3   | March 2020 | [sm1000v3.bin](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v3.bin) |  [sm1000v3.dfu](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v3.dfu) | Menu bug fixes, 700D modem improvements & automatic Mic EQ
    4   | May 2020 | [sm1000v4.bin](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v4.bin) |  [sm1000v4.dfu](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v4.dfu) | 700D sync logic to reduce stop burbling with no signal
-   5   | August 2021 | [sm1000v5.bin](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v5.bin) |  [sm1000v5.dfu](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v5.dfu) | maintenance release due to FreeDV API refactoring, no changes to SM1000 behaivour
+   5   | August 2021 | [sm1000v5.bin](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v5.bin) |  [sm1000v5.dfu](http://www.rowetel.com/downloads/codec2/smartmic/sm1000v5.dfu) | FreeDV 700E and Tx band pass filter for 700D & E
 
 ## Windows
 
@@ -176,7 +178,7 @@ To perform a factory reset, hold down BACK whilst powering the device on. A loud
 
 The SM1000 hardware was developed by David Rowe VK5DGR and Rick Barnich KA8BMA. It is being manufactured, tested and shipped by our good friend Edwin at Dragino in Shenzhen, China.
 
-Steve (K5OKC) helped develop the fine OFDM modem used for FreeDV 700D. Don (W7DMR), spearheaded the port of FreeDV 700D to the SM1000, including code optimisation and a comprehensive unit test system.  Don, Danilo (DB4PLE), and Richard (KF5OIM) have done some fantastic work on the cmake build and test system for the stm32 port of 700D. Stuart VK4MSL developed the morse menu system for the SM1000.
+Steve (K5OKC) helped develop the fine OFDM modem used for FreeDV 700D. Don (W7DMR), spearheaded the port of FreeDV 700D to the SM1000, including code optimisation and a comprehensive unit test system.  Don, Danilo (DB4PLE), and Richard (KF5OIM) have done some fantastic work on the cmake build and test system for the stm32 port of 700D. Stuart VK4MSL developed the morse menu system for the SM1000.  Mooneer, K6AQ, ported FreeDV 700E to the SM1000.
 
 Thanks also to the many Hams who kindly helped out with testing new firmware releases.
 

stm32/src/sm1000_main.c

@@ -133,10 +133,11 @@
  */
 uint8_t core_state = STATE_RX;
 
-#define MAX_MODES  3
+#define MAX_MODES  4
 #define ANALOG     0
 #define DV1600     1
 #define DV700D     2
+#define DV700E     3
 
 struct switch_t sw_select;  /*!< Switch driver for SELECT button */
 struct switch_t sw_back;    /*!< Switch driver for BACK button */
@@ -304,6 +305,25 @@ struct freedv *set_freedv_mode(int op_mode, int *n_samples) {
         freedv_set_snr_squelch_thresh(f, -2.0);  /* squelch at -2.0 dB      */
         freedv_set_squelch_en(f, 1);
         freedv_set_eq(f, 1);                     /* equaliser on by default */
+        
+        /* Clipping and TXBPF nice to have for 700D. */
+        freedv_set_clip(f, 1);
+        freedv_set_tx_bpf(f, 1);
+        
+        *n_samples = freedv_get_n_speech_samples(f);
+        break;
+    case DV700E:
+        usart_printf("FreeDV 700E\n");
+        f = freedv_open(FREEDV_MODE_700E);
+        assert(f != NULL);
+        freedv_set_snr_squelch_thresh(f, 0.0);  /* squelch at 0.0 dB      */
+        freedv_set_squelch_en(f, 1);
+        freedv_set_eq(f, 1);                     /* equaliser on by default */
+
+        /* Clipping and TXBPF needed for 700E. */
+        freedv_set_clip(f, 1);
+        freedv_set_tx_bpf(f, 1);
+
         *n_samples = freedv_get_n_speech_samples(f);
         break;
     }
@@ -468,6 +488,8 @@ int main(void) {
         snprintf(startup_announcement, 16, VERSION " 1600");
     else if (op_mode == DV700D)
         snprintf(startup_announcement, 16, VERSION " 700D");
+    else if (op_mode == DV700E)
+        snprintf(startup_announcement, 16, VERSION " 700E");
     morse_play(&morse_player, startup_announcement);
 
     usart_printf("entering main loop...\n");
@@ -512,7 +534,7 @@ int main(void) {
         }
 
         /* if we have moved from tx to rx reset sync state of rx so we re-start acquisition */
-        if ((op_mode == DV1600) || (op_mode == DV700D))
+        if ((op_mode == DV1600) || (op_mode == DV700D) || (op_mode == DV700E))
             if ((prev_core_state == STATE_TX) && (core_state == STATE_RX))
                 freedv_set_sync(f, FREEDV_SYNC_UNSYNC);
 
@@ -591,7 +613,7 @@ int main(void) {
                         lastms = ms;
                     }
 
-                    /* 1600 or 700D DV mode */
+                    /* 1600 or 700D/E DV mode */
 
                     nin = freedv_nin(f);
                     nout = nin;
@@ -733,7 +755,12 @@ int process_core_state_machine(int core_state, struct menu_t *menu, int *op_mode
                     mode_changed = 1;
                 } else if (switch_released(&sw_back)) {
                     /* Shortcut: change current mode */
-                    *op_mode = (*op_mode - 1) % MAX_MODES;
+                    *op_mode = *op_mode - 1;
+                    if (*op_mode < 0)
+                    {
+                        // Loop back around to the end of the mode list if we reach 0.
+                        *op_mode = MAX_MODES - 1;
+                    }
                     mode_changed = 1;
                 }
 
@@ -745,6 +772,8 @@ int process_core_state_machine(int core_state, struct menu_t *menu, int *op_mode
                         morse_play(&morse_player, "1600");
                     else if (*op_mode == DV700D)
                         morse_play(&morse_player, "700D");
+                    else if (*op_mode == DV700E)
+                        morse_play(&morse_player, "700E");
                     sfx_play(&sfx_player, sound_click);
                 }
             }
@@ -867,6 +896,7 @@ int process_core_state_machine(int core_state, struct menu_t *menu, int *op_mode
  * 	|   |- "ANA"    - Analog
  * 	|   |- "DV1600" - FreeDV 1600 
  * 	|   |- "DV700D" - FreeDV 700D
+ * 	|   |- "DV700E" - FreeDV 700E
  *      |
  * 	|- "TOT"        Timer Out Timer options
  * 	|   |- "TIME"   - Set timeout time (a sub menu)
@@ -915,7 +945,14 @@ static void menu_default_cb(struct menu_t* const menu, uint32_t event)
             break;
         case MENU_EVT_PREV:
             sfx_play(&sfx_player, sound_click);
-            menu->current = (menu->current - 1) % item->num_children;
+            if (menu->current == 0)
+            {
+                menu->current = item->num_children - 1;
+            }
+            else
+            {
+                menu->current = menu->current - 1;
+            }
             announce = 1;
             break;
         case MENU_EVT_SELECT:
@@ -968,7 +1005,7 @@ static const struct menu_item_t menu_op_mode = {
     .label          = "MODE",
     .event_cb       = menu_op_mode_cb,
     .children       = menu_op_mode_children,
-    .num_children   = 3,
+    .num_children   = 4,
 };
 /* Children */
 static const struct menu_item_t menu_op_mode_analog = {
@@ -998,10 +1035,20 @@ static const struct menu_item_t menu_op_mode_dv700D = {
         .ui         = DV700D,
     },
 };
+static const struct menu_item_t menu_op_mode_dv700E = {
+    .label          = "700E",
+    .event_cb       = NULL,
+    .children       = NULL,
+    .num_children   = 0,
+    .data           = {
+        .ui         = DV700E,
+    },
+};
 static struct menu_item_t const* menu_op_mode_children[] = {
     &menu_op_mode_analog,
     &menu_op_mode_dv1600,
     &menu_op_mode_dv700D,
+    &menu_op_mode_dv700E,
 };
 /* Callback function */
 static void menu_op_mode_cb(struct menu_t* const menu, uint32_t event)
@@ -1020,6 +1067,9 @@ static void menu_op_mode_cb(struct menu_t* const menu, uint32_t event)
                 case DV700D:
                     menu->current = 2;
                     break;
+                case DV700E:
+                    menu->current = 3;
+                    break;
                 default:
                     menu->current = 0;
             }
@@ -1034,7 +1084,14 @@ static void menu_op_mode_cb(struct menu_t* const menu, uint32_t event)
             break;
         case MENU_EVT_PREV:
             sfx_play(&sfx_player, sound_click);
-            menu->current = (menu->current - 1) % item->num_children;
+            if (menu->current == 0)
+            {
+                menu->current = item->num_children - 1;
+            }
+            else
+            {
+                menu->current = menu->current - 1;
+            }
             announce = 1;
             break;
         case MENU_EVT_SELECT: