Remove the LED-setting automation feature

Remove the feature that allows setting the RX/TX LEDs after an automation
sequence. Calling set_leds at the start of the next automation sequence (or
before a call to pause_automation) provides the same feature and is less
confusing.

Author: VinDuv

src/lib/automation-utils.c

@@ -6,21 +6,21 @@
 
 
 /* Perform controller switching */
-void switch_controller(enum switch_mode mode, enum led_state end_led_state)
+void switch_controller(enum switch_mode mode)
 {
 	if (mode == REAL_TO_VIRT) {
-		SEND_BUTTON_SEQUENCE(KEEP_LEDS,
+		SEND_BUTTON_SEQUENCE(
 			{ BT_L,			DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Reconnect the controller */
 			{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	10 },	/* Wait for reconnection */
 		);
 	} else {
-		go_to_main_menu(KEEP_LEDS);
+		go_to_main_menu();
 	}
 
 	/* In both cases, the controller is now connected, the main menu is shown, and the
 	   cursor is on the game icon */
 
-	SEND_BUTTON_SEQUENCE((mode == REAL_TO_VIRT) ? KEEP_LEDS : end_led_state,
+	SEND_BUTTON_SEQUENCE(
 		{ BT_NONE,		DP_BOTTOM,	SEQ_HOLD,	1  },	/* News button */
 		{ BT_NONE,		DP_RIGHT,	SEQ_MASH,	3  },	/* Controllers button */
 		{ BT_A,			DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Enter controllers settings */
@@ -32,47 +32,47 @@ void switch_controller(enum switch_mode mode, enum led_state end_led_state)
 	);
 
 	if (mode == REAL_TO_VIRT) {
-		SEND_BUTTON_SEQUENCE(KEEP_LEDS,
+		SEND_BUTTON_SEQUENCE(
 			{ BT_A,			DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Register as controller 1 */
 			{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	15 },	/* Wait for registration */
 
 			{ BT_H,			DP_NEUTRAL,	SEQ_HOLD,	2  },	/* Return to the main menu */
 			{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	25 },	/* Wait for the main menu */
 		);
 
-		go_to_game(end_led_state);
+		go_to_game();
 	}
 }
 
 
 /* Go to the main menu, from the currently playing game or menu. */
-void go_to_main_menu(enum led_state end_led_state)
+void go_to_main_menu(void)
 {
-	SEND_BUTTON_SEQUENCE(KEEP_LEDS,
+	SEND_BUTTON_SEQUENCE(
 		{ BT_H,			DP_NEUTRAL,	SEQ_HOLD,	2  },	/* Go to main menu */
 		{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	25 },	/* Wait for the main menu */
 	);
 }
 
 
 /* Go back to the game, from the main menu. */
-void go_to_game(enum led_state end_led_state)
+void go_to_game(void)
 {
-	SEND_BUTTON_SEQUENCE(end_led_state,
+	SEND_BUTTON_SEQUENCE(
 		{ BT_H,			DP_NEUTRAL,	SEQ_HOLD,	2  },	/* Go back to the game */
 		{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	40 },	/* Wait for the game */
 	);
 }
 
 
 /* Configure the Switch’s clock to manual mode */
-void set_clock_to_manual_from_any(bool in_game, enum led_state end_led_state)
+void set_clock_to_manual_from_any(bool in_game)
 {
 	if (in_game) {
-		go_to_main_menu(KEEP_LEDS);
+		go_to_main_menu();
 	}
 
-	SEND_BUTTON_SEQUENCE(KEEP_LEDS,
+	SEND_BUTTON_SEQUENCE(
 		{ BT_NONE,		DP_BOTTOM,	SEQ_HOLD,	1  },	/* News button */
 		{ BT_NONE,		DP_RIGHT,	SEQ_MASH,	4  },	/* Settings button */
 		{ BT_A,			DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Enter settings */
@@ -90,22 +90,22 @@ void set_clock_to_manual_from_any(bool in_game, enum led_state end_led_state)
 		{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	2  },	/* Wait for menu */
 	);
 
-	go_to_main_menu(in_game ? KEEP_LEDS : end_led_state);
+	go_to_main_menu();
 
 	if (in_game) {
-		go_to_game(end_led_state);
+		go_to_game();
 	}
 }
 
 
 /* Configure the Switch’s clock to automatic mode */
-void set_clock_to_auto_from_manual(bool in_game, enum led_state end_led_state)
+void set_clock_to_auto_from_manual(bool in_game)
 {
 	if (in_game) {
-		go_to_main_menu(KEEP_LEDS);
+		go_to_main_menu();
 	}
 
-	SEND_BUTTON_SEQUENCE(NO_LEDS,
+	SEND_BUTTON_SEQUENCE(
 		{ BT_NONE,		DP_BOTTOM,	SEQ_HOLD,	1  },	/* News button */
 		{ BT_NONE,		DP_RIGHT,	SEQ_MASH,	4  },	/* Settings button */
 		{ BT_A,			DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Enter settings */
@@ -119,16 +119,16 @@ void set_clock_to_auto_from_manual(bool in_game, enum led_state end_led_state)
 		{ BT_A,			DP_NEUTRAL,	SEQ_MASH,	1  },	/* Set to automatic */
 	);
 
-	go_to_main_menu(in_game ? KEEP_LEDS : end_led_state);
+	go_to_main_menu();
 
 	if (in_game) {
-		go_to_game(end_led_state);
+		go_to_game();
 	}
 }
 
 
 /* Apply an offset to the Switch’s clock’s year. */
-void change_clock_year(bool in_game, int8_t offset, enum led_state end_led_state)
+void change_clock_year(bool in_game, int8_t offset)
 {
 	uint8_t button;
 	uint8_t num;
@@ -144,10 +144,10 @@ void change_clock_year(bool in_game, int8_t offset, enum led_state end_led_state
 	}
 
 	if (in_game) {
-		go_to_main_menu(KEEP_LEDS);
+		go_to_main_menu();
 	}
 
-	SEND_BUTTON_SEQUENCE(BOTH_LEDS,
+	SEND_BUTTON_SEQUENCE(
 		{ BT_NONE,		DP_BOTTOM,	SEQ_HOLD,	1  },	/* News button */
 		{ BT_NONE,		DP_RIGHT,	SEQ_MASH,	4  },	/* Settings button */
 		{ BT_A,			DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Enter settings */
@@ -168,9 +168,9 @@ void change_clock_year(bool in_game, int8_t offset, enum led_state end_led_state
 		{ BT_NONE,		DP_NEUTRAL,	SEQ_HOLD,	2  },	/* Wait for menu */
 	);
 
-	go_to_main_menu(in_game ? KEEP_LEDS : end_led_state);
+	go_to_main_menu();
 
 	if (in_game) {
-		go_to_game(end_led_state);
+		go_to_game();
 	}
 }

src/lib/automation-utils.h

@@ -28,20 +28,18 @@ enum switch_mode {
  * currently playing game”. The virtual controller will (re-)connect (as controller 2),
  * activate the controller setup menu, validate it to become back controller 1, and
  * go back to the game.
- *
- * The second parameter allows setting the RX/TX LEDs once the operation completes.
  */
-void switch_controller(enum switch_mode mode, enum led_state end_led_state);
+void switch_controller(enum switch_mode mode);
 
 /*
  * Go to the main menu, from the currently playing game or menu.
  */
-void go_to_main_menu(enum led_state end_led_state);
+void go_to_main_menu(void);
 
 /*
  * Go back to the game, from the main menu.
  */
-void go_to_game(enum led_state end_led_state);
+void go_to_game(void);
 
 /*
  * Configure the Switch’s clock to manual mode, starting from the game or the
@@ -51,9 +49,8 @@ void go_to_game(enum led_state end_led_state);
  *
  * The first parameter indicates that the operations starts in-game (and will end
  * in-game)
- * The second parameter allows setting the RX/TX LEDs once the operation completes.
  */
-void set_clock_to_manual_from_any(bool in_game, enum led_state end_led_state);
+void set_clock_to_manual_from_any(bool in_game);
 
 /*
  * Configure the Switch’s clock to automatic mode, starting from the game or the
@@ -63,9 +60,8 @@ void set_clock_to_manual_from_any(bool in_game, enum led_state end_led_state);
  *
  * The first parameter indicates that the operations starts in-game (and will end
  * in-game)
- * The second parameter allows setting the RX/TX LEDs once the operation completes.
  */
-void set_clock_to_auto_from_manual(bool in_game, enum led_state end_led_state);
+void set_clock_to_auto_from_manual(bool in_game);
 
 /*
  * Apply an offset to the Switch’s clock’s year.
@@ -77,6 +73,6 @@ void set_clock_to_auto_from_manual(bool in_game, enum led_state end_led_state);
  * The second parameter is the year offset to apply (-1: substract a year, 1: add a year)
  * The third parameter allows setting the RX/TX LEDs once the operation completes.
  */
-void change_clock_year(bool in_game, int8_t offset, enum led_state end_led_state);
+void change_clock_year(bool in_game, int8_t offset);
 
 #endif

src/lib/automation.c

@@ -98,10 +98,6 @@ bool init_automation(void)
 /* Set the LED state to be sent in the next request */
 void set_leds(enum led_state leds)
 {
-	if (leds == KEEP_LEDS) {
-		return;
-	}
-
 	if (leds & TX_LED) {
 		sent_data.magic_and_leds |= MAGIC_TX_STATE;
 	} else {
@@ -130,11 +126,10 @@ void send_update(enum button_state buttons, enum d_pad_state d_pad,
 
 /* Send a button sequence */
 void send_button_sequence(const struct button_d_pad_state sequence[],
-	size_t sequence_length, enum led_state end_leds)
+	size_t sequence_length)
 {
 	for (size_t pos = 0 ; pos < sequence_length ; pos += 1) {
 		const struct button_d_pad_state* cur = &sequence[pos];
-		bool is_last = (pos == (sequence_length - 1));
 
 		uint16_t repeat_count = cur->repeat_count;
 		enum seq_mode mode = cur->mode;
@@ -143,10 +138,6 @@ void send_button_sequence(const struct button_d_pad_state sequence[],
 			sent_data.buttons = cur->buttons;
 			sent_data.d_pad = cur->d_pad;
 
-			if (is_last && repeat_count == 1) {
-				set_leds(end_leds);
-			}
-
 			send_current();
 
 			if (mode == SEQ_MASH) {

src/lib/automation.h

@@ -28,7 +28,6 @@ enum led_state {
 	TX_LED = 0x01, /* Turn on TX LED */
 	RX_LED = 0x02, /* Turn on RX LED */
 	BOTH_LEDS = 0x03, /* Turn on RX and TX LEDs */
-	KEEP_LEDS = 0x04, /* Do not change the LEDs state */
 };
 
 /* Stick coordinates */
@@ -120,22 +119,21 @@ void send_update(enum button_state buttons, enum d_pad_state d_pad,
  * Send a button sequence.
  * The first parameter is a pointer to an array of states to run in sequence.
  * The second parameter is the number of entries in the array.
- * The third parameter is the led state to set at the end of the sequence.
  */
 void send_button_sequence(const struct button_d_pad_state sequence[],
-	size_t sequence_length, enum led_state end_leds);
+	size_t sequence_length);
 
 /*
  * Macro to simplify the use of send_button_sequence.
  *
- * Example usage: SEND_BUTTON_SEQUENCE(NO_LEDS, { BUTTON_A, DP_NEUTRAL, SEQ_HOLD, 5},
+ * Example usage: SEND_BUTTON_SEQUENCE({ BUTTON_A, DP_NEUTRAL, SEQ_HOLD, 5},
  * { NO_BUTTONS, DP_TOP, SEQ_HOLD, 1 });
  */
-#define SEND_BUTTON_SEQUENCE(END_LEDS, FIRST_STATE, ...) \
+#define SEND_BUTTON_SEQUENCE(FIRST_STATE, ...) \
 	send_button_sequence((struct button_d_pad_state[]){ \
 		FIRST_STATE, __VA_ARGS__ }, sizeof((struct button_d_pad_state[]){ \
 		FIRST_STATE, __VA_ARGS__ }) / \
-		sizeof(struct button_d_pad_state), END_LEDS);
+		sizeof(struct button_d_pad_state));
 
 /*
  * Send an update that reset the button/controller state to a neutral state