Set pins to a predetermined value before exit

There are cases when some pins are not direct I/Os. They are
used to activate certain HW modules and must be brought to a
certain value before exit, otherwise functionality might be
affected.
An example is S32N79RDB board, where leaving EN_CNTL_I2C or
EN_RCON_I2C lines active, puts the FTDI4232's I2C lines in
parallel with the CPU's and creates interferences during debug
time.

Signed-off-by: Costin Constantin <costin.constantin@nxp.com>

Author: costinctin

bcu.c

@@ -231,6 +231,7 @@ static void print_help(char* cmd)
 
 static void lsgpio(struct options_setting* setting)
 {
+	setting->no_release_pins = 1;
 	struct board_info* board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -248,6 +249,7 @@ static void lsgpio(struct options_setting* setting)
 
 static void lsboard(struct options_setting* setting)
 {
+	setting->no_release_pins = 1;
 	printf("\nlist of supported board model:\n\n");
 	for (int i = 0; i < num_of_boards; i++)
 	{
@@ -375,6 +377,7 @@ void free_gpio(struct gpio_device* gpio)
 
 static void ptc_set_target_temperature(struct options_setting *setting)
 {
+	setting->no_release_pins = 1;
 	struct board_info *board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -451,6 +454,7 @@ static void ptc_set_target_temperature(struct options_setting *setting)
 
 static void ptc_set_current_temperature(struct options_setting *setting)
 {
+	setting->no_release_pins = 1;
 	struct board_info *board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -489,6 +493,7 @@ static void ptc_set_current_temperature(struct options_setting *setting)
 
 static void ptc_get_temperature(struct options_setting *setting) //
 {
+	setting->no_release_pins = 1;
 	struct board_info *board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -523,6 +528,7 @@ static void ptc_get_temperature(struct options_setting *setting) //
 
 static void ptc_get_is_stable(struct options_setting *setting) //
 {
+	setting->no_release_pins = 1;
 	struct board_info *board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -564,6 +570,7 @@ static void ptc_get_is_stable(struct options_setting *setting) //
 
 static void ptc_get_is_enable(struct options_setting *setting) //
 {
+	setting->no_release_pins = 1;
 	struct board_info *board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -605,6 +612,7 @@ static void ptc_get_is_enable(struct options_setting *setting) //
 
 static void get_temp(struct options_setting* setting)//
 {
+	setting->no_release_pins = 1;
 	struct board_info* board = get_board(setting->board);
 	if (board == NULL)
 		return;
@@ -699,7 +707,7 @@ static void set_gpio(struct options_setting* setting)
 	if (status)
 		printf("set gpio failed, error = 0x%x\n", status);
 	else
-		printf("set gpio successfully\n");
+		printf("%s gpio set to %d successfully\n", setting->gpio_name, setting->output_state);
 
 	//hold time
 	msleep(setting->hold);
@@ -1620,6 +1628,7 @@ static int eeprom(struct options_setting* setting)
 	void* head = NULL;
 	void* end_point;
 	int j = 0;
+	setting->no_release_pins = 1;
 
 	struct board_info* board=get_board(setting->board);
 	if (board == NULL)
@@ -1790,6 +1799,7 @@ static char catch_input_char_block()
 static void monitor(struct options_setting* setting)
 {
 	signal(SIGINT, handle_sigint);
+	setting->no_release_pins = 1;
 	struct board_info* board = get_board(setting->board);
 	if (board == NULL) {
 		// printf("entered board model are not supported.\n");
@@ -3184,6 +3194,7 @@ char *iso8601(char *local_time)
 static int server_monitor(struct options_setting* setting)
 {
 	signal(SIGINT, handle_sigint);
+	setting->no_release_pins = 1;
 	struct board_info* board = get_board(setting->board);
 	if (board == NULL) {
 		// printf("entered board model are not supported.\n");
@@ -4049,6 +4060,7 @@ static int lsftdi(struct options_setting* setting)
 
 
 	int board_num = 0;
+	setting->no_release_pins = 1;
 	char location_id_str[MAX_NUMBER_OF_USB_DEVICES][MAX_LOCATION_ID_LENGTH];
 	if (!setting->auto_find_board)
 		ft_list_devices(location_id_str, &board_num, LIST_DEVICE_MODE_PRINT);
@@ -4168,6 +4180,36 @@ void terminateBCU(void)
 	ft4232h_i2c_remove_all(enable_exit_handler);
 }
 
+static int release_pins_before_exit(struct options_setting* setting)
+{
+
+	if (setting->no_release_pins)
+	{
+		return 0;
+	}
+
+	struct board_info* board = get_board(setting->board);
+	if (board == NULL || !board->gpio_on_exit)
+	{
+		return 0;
+	}
+
+	int i = 0;
+	while (board->gpio_on_exit[i].name != NULL)
+	{
+		if (i == 0)
+		{
+			setting->hold = 0;
+			printf("\nReleasing pins before exit:\n");
+		}
+		strcpy(setting->gpio_name, board->gpio_on_exit[i].name);
+		setting->output_state = board->gpio_on_exit[i].value;
+		set_gpio(setting);
+		i++;
+	}
+	return 1;
+}
+
 int main(int argc, char** argv)
 {
 	setbuf(stdin, NULL);
@@ -4534,9 +4576,16 @@ int main(int argc, char** argv)
 	else
 	{
 		printf("%s is a invalid command\n\n", cmd);
+		setting.no_release_pins = 1;
 		print_help(NULL);
 	}
 
+	// exit by setting required pins to a predefined state
+	if(!release_pins_before_exit(&setting) && !setting.no_release_pins)
+	{
+		printf("No pins release before exit required.\n");
+	}
+	
 	printf("done\n");
 	return 0;
 }

bcu_parser.h

@@ -90,6 +90,7 @@ struct options_setting {
 	int ptc_onoff;
 	int ptc_sensor;
 	int autoranging;
+	int no_release_pins; // no need to release pins before exit
 };
 
 struct group {

board.c

@@ -2550,6 +2550,13 @@ struct boot_config s32n79_boot_config[] = {
 	{NULL,		{0}}
 };
 
+// pins that must be set to a certain state. Without this some functionalities of S32N79RDB are affected
+struct gpio_state_on_exit s32n79_pins_on_exit[] = {
+	{"EN_CNTL_I2C", 1},
+	{"EN_RCON_I2C", 1},
+	{NULL, 0}
+};
+
 struct board_info board_list[] =
 {
 	{"imx8dxlevk",		imx8xxl,		imx8xxl_boot_modes,		0,	NULL,				imx8xxl_power_groups,		imx8xxlevk_board_links,		&imx8dxlevk_ftdi_eeprom_user_area_info,		500},
@@ -2594,7 +2601,7 @@ struct board_info board_list[] =
 	{"imx943evk19a0",	imx943evk19a0_board,	imx943_board_boot_modes,	0,	NULL,				imx943evk19_power_groups,	null_board_links,		&imx943evk19_ftdi_eeprom_user_area_info,	500},
 	{"imx943evk19b1",	imx943evk19b1_board,	imx943_board_boot_modes,	0,	NULL,				imx943evk19_power_groups,	null_board_links,		&imx943evk19b1_ftdi_eeprom_user_area_info,	500},
 	{"imx943obx",		imx943obx_board,	imx943_board_boot_modes,	0,	NULL,				imx943evk19_power_groups,	null_board_links,		&imx943obx_ftdi_eeprom_user_area_info,		500},
-	{"s32n79rdb",		s32n79_mappings,	s32n79_boot_modes,	0,	s32n79_boot_config,	NULL,	null_board_links,	&s32n79rdb_ftdi_eeprom_user_area_info,	500},
+	{"s32n79rdb",		s32n79_mappings,	s32n79_boot_modes,	0,	s32n79_boot_config,	NULL,	null_board_links,	&s32n79rdb_ftdi_eeprom_user_area_info,	500, s32n79_pins_on_exit},
 	{"val_board_7",		val_board_7_board,	imx943_board_boot_modes,	0,	NULL,				NULL,				null_board_links,		&val_board_7_ftdi_eeprom_user_area_info,	500},
 	{"val_board_9",		val_board_9_board,	null_boot_mode,			0,	NULL,				val_board_9_power_groups,	null_board_links,		&val_board_9_ftdi_eeprom_user_area_info,	500},
 	{"val_board_10",	val_board_10_board,	val_board_10_boot_modes,	0,	NULL,				val_board_10_power_groups,	null_board_links,		&val_board_10_ftdi_eeprom_user_area_info,	500},

board.h

@@ -76,6 +76,12 @@ struct boot_config {
 								*/
 };
 
+// there are cases when before exit certain pins used as enablers for hw functionalities must be brought to a known value
+struct gpio_state_on_exit {
+	const char* name;
+	int value;
+};
+
 struct board_links {
 	char* flashbin;
 	char* sdcard;
@@ -96,6 +102,7 @@ struct board_info {
 	struct board_links* links;
 	struct ftdi_eeprom_user_area* eeprom_data;
 	unsigned int reset_time_ms;
+	struct gpio_state_on_exit* gpio_on_exit;
 };
 
 /*find if there is the gpio_name on the board*/
@@ -121,4 +128,4 @@ char* get_boot_mode_name_from_hex(struct board_info* board, int boot_mode_hex);
 char* get_boot_config_name_from_hex(struct board_info* board, int *boot_config_hex, int boot_mode_hex);
 enum mapping_type get_mapping_type(char* mapping_name, struct board_info* board);
 
-#endif //BOARD_H
+#endif //BOARD_H