replace device define macros with devicetree-based macro

[pabigot]

With the merge of #30196 we need to convert any device object definitions that are based on a devicetree node to use DEVICE_DT_DEFINE instead of:

• DEVICE_DEFINE 17 driver source files
• DEVICE_AND_API_INIT 361 driver source files

The vast majority of these are for devices that are associated with a devicetree node. Changing allows use of new API to access the device object directly via DEVICE_DT_GET() rather than a runtime lookup through the label property, and provides access to additional common devicetree information like dependencies.

Examples of the sort of changes required include:

• 63043bc when instance macros based on iterating over devices are already used;
• cf33927 when interrupts require local direct access to the device before it is defined.

There will be remaining instances of DEVICE_DEFINE and/or DEVICE_AND_API_INIT for device objects that do not derive from devicetree, such as USB class instance devices like CDC_ACM.

Note

The role of this issue is solely to replace the macros used to define struct device objects when a device corresponds to a devicetree node. It enables, but does not implement, changes in device references in driver from ones that use the label property. As noted in #30536 that can only be done when all drivers in a given subsystem have been converted.

[pabigot]

What this will enable is replacement of:

struct gpio_cfg {
  const char *label;
  gpio_pin_t pin;
  gpio_dt_flags_t flags;
};

static const struct gpio_cfg cfg = {
   .label = DT_GPIO_LABEL(NODE_ID, foo_gpios),
   .pin = DT_GPIO_PIN(NODE_ID, foo_gpios),
   .flags = DT_GPIO_FLAGS(NODE_ID, foo_gpios),
};
static const struct device *gpio;

...
gpio = device_get_binding(cfg->label);
if (gpio) {
  gpio_configure(gpio, cfg->pin, GPIO_OUTPUT_INACTIVE | cfg->flags);
}

with

struct gpio_cfg {
  const struct device *dev;
  gpio_pin_t pin;
  gpio_dt_flags_t flags;
};

// the need for this this may go away with tooling enhancements
DEVICE_DT_DECLARE(DT_GPIO_CTLR(NODE_ID, foo_gpios));

static const struct gpio_cfg cfg = {
   .dev = DEVICE_DT_GET(DT_GPIO_CTLR(NODE_ID, foo_gpios)),
   .pin = DT_GPIO_PIN(NODE_ID, foo_gpios),
   .flags = DT_GPIO_FLAGS(NODE_ID, foo_gpios),
};

...

if (device_is_ready(cfg->dev)) {
  gpio_configure(cfg->dev, cfg->pin, GPIO_OUTPUT_INACTIVE | cfg->flags);
}

[pabigot]

Based on TSC discussion we'll just go ahead with this, in separate PRs grouped by reasonable categories (subsystem and/or SOC family). If you're willing to help please assign yourself, and where possible identify the areas where you intend to work so we don't duplicate effort. We do need a decision soon on #30400 so we know which style of macro to use: my current position is here. that got merged, so I guess we're using the wrapper.

[galak]

PR for I2C controllers - #30561

[jfischer-no]

@pabigot I can help/take-over display controller drivers and USB relevant things.

[galak]

Converted ADC (#30567) and SPI (#30568)

[galak]

Converted PWM (#30570)

[galak]

Converted watchdog (#30592)

[galak]

Converted GPIO (#30597)