Missing error check of device_get_binding() and flash_area_open()

[Hxinrong]

Hi,
As described in the API documentation, function device_get_binding() is used to retrieve the device structure for a driver by name, and returns the pointer to device structure, or NULL if not found or cannot be used. But as shown in the following three call sites, the error checks are not made.

zephyr/drivers/console/uart_console.c

Lines 600 to 604 in 0a0404d

	uart_console_dev = device_get_binding(CONFIG_UART_CONSOLE_ON_DEV_NAME);
	uart_console_hook_install();
	return 0;

zephyr/drivers/display/ssd1306.c

Lines 413 to 414 in 0a0404d

	driver->cs_ctrl.gpio_dev = device_get_binding(
	DT_INST_SPI_DEV_CS_GPIOS_LABEL(0));

zephyr/drivers/display/display_st7789v.c

Lines 353 to 354 in 0a0404d

	data->cs_ctrl.gpio_dev = device_get_binding(
	DT_INST_SPI_DEV_CS_GPIOS_LABEL(0));

Moreover, in other sites, the return values of device_get_binding() have been checked for NULL. For instance,

zephyr/drivers/flash/spi_nor.c

Lines 848 to 852 in 0a0404d

	data->cs_ctrl.gpio_dev =
	device_get_binding(DT_INST_SPI_DEV_CS_GPIOS_LABEL(0));
	if (!data->cs_ctrl.gpio_dev) {
	return -ENODEV;
	}

zephyr/drivers/display/gd7965.c

Lines 438 to 442 in 0a0404d

	driver->cs_ctrl.gpio_dev = device_get_binding(GD7965_CS_CNTRL);
	if (!driver->cs_ctrl.gpio_dev) {
	LOG_ERR("Unable to get SPI GPIO CS device");
	return -EIO;
	}

===================================================================================
Also, function flash_area_open() is used to retrieve partitions flash area from the flash_map, and returns 0 on success, -EACCES if the flash_map is not available , or -ENOENT if ID is unknown. But in the following codes, the return value of it is not checked before the call of flash_area_erase().

zephyr/tests/subsys/settings/fcb/src/settings_test_fcb.c

Lines 190 to 195 in 0a0404d

	rc = flash_area_open(FLASH_AREA_ID(storage), &fap);
	for (i = 0; i < cnt; i++) {
	rc = flash_area_erase(fap, fs[i].fs_off, fs[i].fs_size);
	zassert_true(rc == 0, "Can't get flash area");
	}

However, in other parts, the return values are error checked. As shown in the following codes,

zephyr/tests/subsys/settings/functional/src/settings_basic_test.c

Lines 34 to 39 in 0a0404d

	int rc = flash_area_open(FLASH_AREA_ID(storage), &fap);
	if (rc == 0) {
	rc = flash_area_erase(fap, 0, fap->fa_size);
	flash_area_close(fap);
	}

zephyr/tests/subsys/fs/littlefs/src/testfs_lfs.c

Lines 55 to 61 in 0a0404d

	int rc = flash_area_open(id, &pfa);
	if (rc < 0) {
	TC_PRINT("Error accessing flash area %u [%d]\n",
	id, rc);
	return TC_FAIL;
	}

[github-actions]

This issue has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this issue will automatically be closed in 14 days. Note, that you can always re-open a closed issue at any time.