Merging SWW into master

benchmark/MLPerfTiny_Rules.adoc

@@ -177,6 +177,7 @@ The suite includes the following benchmarks:
 |   Visual Wake Words  |           Binary image classification           | Visual Wake Words Dataset |     MobileNet    |   80% (Top 1)
 | Image Classification |            Small image classification           |          Cifar10          |      ResNet      |   85% (Top 1)
 |   Anomaly Detection  | Detecting anomalies in machine operating sounds |          ToyADMOS         | Deep AutoEncoder |   0.85 (AUC)
+|   Streaming Wakeword | Detecting wakewords in a continuous stream of audio| Custom         | 1D DS-CNN |  TBD
 |===
 
 ==== Relaxed constraints for the Open division
@@ -189,10 +190,13 @@ The suite includes the following benchmarks:
 
 == Benchmark Runner
 
+
+
 === EnergyRunner™ benchmark framework
-The benchmark suite is run using the EnergyRunner™ benchmark framework, which detects the DUT, sends inputs, and reads outputs over UART.
+The benchmark suite is run using the EnergyRunner™ benchmark framework from EEMBC, which detects the DUT, sends inputs, and reads outputs over UART.  The EEMBC runner is being phased out.  It will be permitted for teh KWS, VWW, IC, and AD benchmarks in the summer 2015 submission.  After that, only the MLCommons Runner will be permitted.  The EEMBC runner does not support the streaming wakeword benchmark.
 
-The runner is available here: https://github.com/eembc/energyrunner
+The EEMBC runner is available here: https://github.com/eembc/energyrunner
+The MLCommons runner is available in this repository: https://github.com/mlcommons/tiny/tree/master/benchmark/runner
 
 Note: The same code must be run for both the accuracy and performance Runner modes.
 
@@ -332,7 +336,8 @@ The following techniques are disallowed:
 
 * Discarding non-zero weight elements, including pruning
 
-* Caching queries or responses
+* Caching queries or responses between files.  However, in the streaming test, it is
+permitted to store intermediate activations between frames of the same waveform.
 
 * Coalescing identical queries
 

benchmark/interface/.gitignore

@@ -2,3 +2,5 @@
 cmake-build-*/
 /STM32CubeIDE/Debug/
 /STM32CubeIDE/Release/
+STM32CubeIDE/.settings/
+.metadata/

benchmark/interface/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>interface</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

benchmark/interface/Application/CLI/InterfaceMenu.cpp

@@ -1,6 +1,11 @@
 #include "InterfaceMenu.hpp"
 #include "../IDataSource.hpp"
+#include "../Audio/WaveSink.hpp"
 #include "../ResourceManager.hpp"
+#include "usart.h"
+#include "baud_config.h"
+
+
 
 void CLI_Init(TX_BYTE_POOL *byte_pool, UART_HandleTypeDef *huart)
 {
@@ -14,6 +19,29 @@ void CLI_Run()
   CLI::InterfaceMenu::GetSingleton().Run();
 }
 
+void Record_WW_Detection()
+{
+  CLI::InterfaceMenu::GetSingleton().RecordOneDetection();
+}
+
+void Record_Dutycycle_Start()
+{
+	if( CLI::InterfaceMenu::InstanceInitialized() )
+	{
+		// only call this if the CLI instance is initialized
+		CLI::InterfaceMenu::GetSingleton().DutycycleStart();
+	}
+}
+void Record_Dutycycle_Stop()
+{
+	if( CLI::InterfaceMenu::InstanceInitialized() )
+	{
+		// only call this if the CLI instance is initialized
+		CLI::InterfaceMenu::GetSingleton().DutycycleStop();
+	}
+}
+
+
 namespace CLI
 {
   InterfaceMenu *InterfaceMenu::instance = (InterfaceMenu *)TX_NULL;
@@ -26,8 +54,22 @@ namespace CLI
                                                         {"name", NameWrapper},
                                                         {"ls", ListWrapper},
                                                         {"play", PlayWrapper},
+														{"setbaud", SetBaudWrapper},
+														{"checkbaud", CheckBaudWrapper},
+														{"record_detections", RecDetsWrapper},
+														{"print_detections", PrintDetsWrapper},
+														{"print_dutycycle", PrintDutycycleWrapper},
                                                         {"", DefaultWrapper} };
 
+  bool InterfaceMenu::InstanceInitialized()
+  {
+	  if( instance )
+		  return true;
+	  else
+		  return false;
+  }
+
+
   /**
    * Wrap the singleton function in a static function
    */
@@ -51,6 +93,43 @@ namespace CLI
   {
     instance->Play(args);
   }
+  /**
+   * Wrap the singleton function in a static function
+   */
+  void InterfaceMenu::SetBaudWrapper(const std::string &args)
+    {
+      instance->SetBaud(args);
+    }
+  /**
+   * Wrap the singleton function in a static function
+   */
+  void InterfaceMenu::CheckBaudWrapper(const std::string &args)
+    {
+      instance->CheckBaud(args);
+    }
+  /**
+   * Wrap the singleton function in a static function
+   */
+  void InterfaceMenu::RecDetsWrapper(const std::string &args)
+  {
+    instance->RecordDetections(args);
+  }
+
+  /**
+   * Wrap the singleton function in a static function
+   */
+  void InterfaceMenu::PrintDetsWrapper(const std::string &args)
+  {
+    instance->PrintDetections(args);
+  }
+
+  /**
+   * Wrap the singleton function in a static function
+   */
+  void InterfaceMenu::PrintDutycycleWrapper(const std::string &args)
+  {
+    instance->PrintDutycycle(args);
+  }
 
   /**
    * Wrap the singleton function in a static function
@@ -155,14 +234,132 @@ namespace CLI
    */
   void InterfaceMenu::Play(const std::string &args)
   {
+	Audio::PlayerResult result;
     IDataSource *source = file_system.OpenFile(args);
     Audio::WaveSource wav(*source);
-    std::string *msg = new std::string("Playing ");
+//    if( !wav.valid_wave ) {
+//    	std::string *msg = new std::string("Error. Not a valid wav file: ");
+//		msg->append(source->GetName());
+//		msg->append("\n");
+//		SendString(msg->c_str());
+//    }
+    std::string *msg = new std::string("Attempting to play ");
     msg->append(source->GetName());
     msg->append("\n");
     SendString(msg->c_str());
-    player.Play(wav);
+    result = player.Play(wav);
+    if( result == Audio::ERROR ) {
+    	SendString("Error playing file. Check that the file exists and is a 2-channel wav file.\n");
+    }
+    else {
+    	SendString("succeeded.\n");
+    }
+
     SendEnd();
     delete source;
   }
+
+  /**
+   * Set the new baud rate for the board
+   */
+  void InterfaceMenu::SetBaud(const std::string &args)
+  {
+      int baud = std::stoi(args);
+      SaveBaudRateToFlash(baud);  // Save permanently to Flash
+
+      SendString("set baud to: " + args + "\n");
+
+      SendEnd();
+      NVIC_SystemReset();  //Reset the MCU
+  }
+
+
+  /**
+   * Check the current baud rate
+   */
+  void InterfaceMenu::CheckBaud(const std::string &args)
+  {
+      int currentBaud = huart3.Init.BaudRate;
+
+      SendString("baud is: " + std::to_string(currentBaud) + "\n");
+
+      SendEnd();  // End response
+  }
+
+
+
+
+  void InterfaceMenu::RecordDetections(const std::string &args)
+  {
+	  // Sets the interface board into mode to capture detections,
+	  // but the detections are recorded in an interrupt handler,
+	  // so we can return here and proceed to playing the wav file
+
+	  __HAL_TIM_SET_COUNTER(&htim2, 0);
+	  SendString("Now recording detections");
+	  SendEndLine();
+	  dut.StartRecordingDetections();
+	  SendEnd();
+  }
+
+  void InterfaceMenu::PrintDetections(const std::string &args)
+  {
+	  uint32_t *timestamps = dut.GetDetections();
+	  uint32_t num_timestamps = dut.GetNumDetections();
+
+	  SendString("Detection Timestamps (ms)");
+	  SendEndLine();
+	  for(uint32_t i=0; i<num_timestamps; i++)
+	  {
+		  SendString(std::to_string(timestamps[i]) + ",");
+		  SendEndLine();
+	  }
+	  SendEnd();
+  }
+
+  void InterfaceMenu::PrintDutycycle(const std::string &args)
+  {
+	  uint32_t *rising_edges = dut.GetDutycycleRisingEdges();
+	  uint32_t num_rising_edges = dut.GetNumDutycycleRisingEdges();
+	  uint32_t *falling_edges = dut.GetDutycycleFallingEdges();
+	  uint32_t num_falling_edges = dut.GetNumDutycycleFallingEdges();
+
+	  SendString("Duty cycle start times (s)");
+	  SendEndLine();
+	  for(uint32_t i=0; i<num_rising_edges; i++)
+	  {
+		  SendString(std::to_string(rising_edges[i]) + ", ");
+		  if( (i+1) % 8 == 0){
+			  SendEndLine();
+		  }
+	  }
+	  SendEndLine();
+	  SendString("Duty cycle stop times (s)");
+	  SendEndLine();
+	  for(uint32_t i=0; i<num_falling_edges; i++)
+	  {
+		  SendString(std::to_string(falling_edges[i]) + ", ");
+		  if( (i+1) % 8 == 0){
+			  SendEndLine();
+		  }
+	  }
+	  SendEnd();
+  }
+
+
+  void InterfaceMenu::RecordOneDetection()
+  {
+	  dut.RecordDetection();
+  }
+
+  void InterfaceMenu::DutycycleStart()
+  {
+	  dut.RecordDutycycleStart();
+  }
+
+  void InterfaceMenu::DutycycleStop()
+  {
+	  dut.RecordDutycycleStop();
+  }
+
 }

benchmark/interface/Application/CLI/InterfaceMenu.h

@@ -19,6 +19,10 @@ void CLI_Init(TX_BYTE_POOL *byte_pool, UART_HandleTypeDef *huart);
  */
 void CLI_Run();
 
+void Record_WW_Detection();
+void Record_Dutycycle_Stop();
+void Record_Dutycycle_Start();
+
 #ifdef __cplusplus
 }
 #endif

benchmark/interface/Application/CLI/InterfaceMenu.hpp

@@ -19,6 +19,28 @@ namespace CLI
      * @return the menu instance
      */
     static InterfaceMenu &GetSingleton();
+    void RecordOneDetection();
+    void DutycycleStart();
+    void DutycycleStop();
+
+
+    // Wrapper function declarations
+    static void ListWrapper(const std::string &args);
+    static void NameWrapper(const std::string &args);
+    static void PassthroughWrapper(const std::string &args);
+    static void PlayWrapper(const std::string &args);
+    static void SetBaudWrapper(const std::string &args);
+    static void CheckBaudWrapper(const std::string &args);
+    static void RecDetsWrapper(const std::string &args);
+    static void PrintDetsWrapper(const std::string &args);
+    static void PrintDutycycleWrapper(const std::string &args);
+    static void DefaultWrapper(const std::string &args);
+    static bool InstanceInitialized();
+
+    // Declarations for SetBaud and CheckBaud
+    void SetBaud(const std::string &args);
+    void CheckBaud(const std::string &args);
+
   private:
     /**
      * Allow CLI_Init access to private constructor to create the singleton.
@@ -28,20 +50,22 @@ namespace CLI
     static TX_MUTEX singleton_mutex;
     static InterfaceMenu *instance;
     static void InitSingleton(TX_BYTE_POOL &byte_pool, IO::Uart *uart, IO::FileSystem &file_system, Audio::WaveSink &player, Test::DeviceUnderTest &dut);
-    static void ListWrapper(const std::string &args);
-    static void NameWrapper(const std::string &args);
-    static void PassthroughWrapper(const std::string &args);
-    static void PlayWrapper(const std::string &args);
-    static void DefaultWrapper(const std::string &args);
+
     InterfaceMenu(TX_BYTE_POOL &byte_pool, IO::Uart &uart, IO::FileSystem &file_system, Audio::WaveSink &player, Test::DeviceUnderTest &dut);
     void List(const std::string &args);
     void Name(const std::string &args);
     void Passthrough(const std::string &args);
     void Play(const std::string &args);
+    void RecordDetections(const std::string &args);
+    void PrintDetections(const std::string &args);
+    void PrintDutycycle(const std::string &args);
+
     IO::FileSystem &file_system;
     Audio::WaveSink &player;
     Test::DeviceUnderTest &dut;
   };
 }
 
-#endif //CLI_INTERFACEMENU_HPP
+void Record_WW_Detection();
+
+#endif // CLI_INTERFACEMENU_HPP

benchmark/interface/Application/CLI/Menu.cpp

@@ -1,5 +1,6 @@
 #include "Menu.hpp"
 #include "usart.h"
+#include "tim.h" // jhdbg only needed for debug
 
 #define RESPONSE_QUEUE_SIZE     20 * sizeof(ULONG)
 
@@ -20,6 +21,17 @@ namespace CLI
       const std::string *buffer = uart.ReadUntil("%");
       HandleCommand(*buffer);
       delete buffer;
+
+	  // HAL_GPIO_WritePin(WW_DET_IN_GPIO_Port, WW_DET_IN_Pin, GPIO_PIN_SET);
+      // int delay_start = __HAL_TIM_GET_COUNTER(&htim2);
+      // while(__HAL_TIM_GET_COUNTER(&htim2) < delay_start + 100 ){
+      // 	;
+      // }
+      // HAL_GPIO_WritePin(WW_DET_IN_GPIO_Port, WW_DET_IN_Pin, GPIO_PIN_RESET);
+
+      // int pin_val = HAL_GPIO_ReadPin(WW_DET_IN_GPIO_Port, WW_DET_IN_Pin);
+      // std::string message = "pin is " + std::to_string(pin_val);
+      // uart.SendString(message);
     }
   }
 

benchmark/interface/Application/ResourceManager.cpp

@@ -63,3 +63,5 @@ ResourceManager::ResourceManager(TX_BYTE_POOL &byte_pool): task_runner(new Tasks
                                                            dut(new Test::DeviceUnderTest(*task_runner, new IO::Uart(byte_pool, &huart3)))
 {
 }
+
+