port_esp_hosted_host_config.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_esp_hosted_pins.h"
 
/* ----------------------------------------------------------------------- */
/* Transport identity */
/* ----------------------------------------------------------------------- */
 
/*
 * The core only ever compares these against each other, so the numbering is
 * free; it is dense and starts at zero so "none" is falsy.
 */

#define H_TRANSPORT_NONE (0)

#define H_TRANSPORT_SPI (1)

#define H_TRANSPORT_SDIO (2)

#define H_TRANSPORT_SPI_HD (3)

#define H_TRANSPORT_UART (4)

#define H_TRANSPORT_IN_USE (H_TRANSPORT_SPI)
 
/* ----------------------------------------------------------------------- */
/* Co-processor part number */
/* ----------------------------------------------------------------------- */
 
/*
 * Exactly one of these is 1; transport_drv.c turns it into the chip id it
 * expects to read back in the co-processor's boot event, and mismatches are
 * reported rather than ignored. The upstream macro names carry a legacy role
 * word this project does not use in its own prose.
 */

#define H_SLAVE_TARGET_ESP32C6 (1) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32C2 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32C3 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32C5 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32C61 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32H2 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32H4 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32S2 (0) /* LEGACY-OK: upstream esp-hosted macro name */

#define H_SLAVE_TARGET_ESP32S3 (0) /* LEGACY-OK: upstream esp-hosted macro name */
 
/* ----------------------------------------------------------------------- */
/* Packed-pin to (void* port, int pin) adapters */
/* ----------------------------------------------------------------------- */

#define RA8_ESP_HOSTED_GPIO_PORT(pin_code) ((void*)(uintptr_t)RA8_PIN_PORT(pin_code))

#define RA8_ESP_HOSTED_GPIO_PIN(pin_code)                                                          \
  (((uint16_t)(pin_code) == (uint16_t)k_ra8_pin_none) ? (-1) : (int)RA8_PIN_PIN(pin_code))
 
/* ----------------------------------------------------------------------- */
/* Side-band pin map */
/* ----------------------------------------------------------------------- */
 
/*
 * Note the upstream spellings: CamelCase _Port / _Pin for HANDSHAKE and
 * DATA_READY, but a _PORT_ / _PIN_ infix for RESET. Both are verified against
 * spi_drv.c and esp_hosted_transport_config.c.
 */

/* NOLINTNEXTLINE(readability-identifier-naming) -- upstream-fixed mixed-case spelling. */
#define H_GPIO_HANDSHAKE_Port RA8_ESP_HOSTED_GPIO_PORT(k_ra8_esp_hosted_pin_handshake)

/* NOLINTNEXTLINE(readability-identifier-naming) -- upstream-fixed mixed-case spelling. */
#define H_GPIO_HANDSHAKE_Pin RA8_ESP_HOSTED_GPIO_PIN(k_ra8_esp_hosted_pin_handshake)

/* NOLINTNEXTLINE(readability-identifier-naming) -- upstream-fixed mixed-case spelling. */
#define H_GPIO_DATA_READY_Port RA8_ESP_HOSTED_GPIO_PORT(k_ra8_esp_hosted_pin_data_ready)

/* NOLINTNEXTLINE(readability-identifier-naming) -- upstream-fixed mixed-case spelling. */
#define H_GPIO_DATA_READY_Pin RA8_ESP_HOSTED_GPIO_PIN(k_ra8_esp_hosted_pin_data_ready)

#define H_GPIO_PORT_RESET RA8_ESP_HOSTED_GPIO_PORT(k_ra8_esp_hosted_pin_reset)

#define H_GPIO_PIN_RESET RA8_ESP_HOSTED_GPIO_PIN(k_ra8_esp_hosted_pin_reset)
 
/* ----------------------------------------------------------------------- */
/* Side-band polarity and interrupt sense */
/* ----------------------------------------------------------------------- */
 
/*
 * The C6 image drives both HANDSHAKE and DATA_READY push-pull and asserts
 * them HIGH, so both flags are 1 and both edges are rising. The derived
 * values below follow from the flags, never the other way round.
 */

#define H_HANDSHAKE_ACTIVE_HIGH (1)

#define H_DATAREADY_ACTIVE_HIGH (1)
 
#if H_HANDSHAKE_ACTIVE_HIGH

#define H_HS_VAL_ACTIVE (1)

#define H_HS_VAL_INACTIVE (0)

#define H_HS_INTR_EDGE (1)
 
#else /* active-low HANDSHAKE harness */

#define H_HS_VAL_ACTIVE   (0)

#define H_HS_VAL_INACTIVE (1)

#define H_HS_INTR_EDGE    (0)
 
#endif /* H_HANDSHAKE_ACTIVE_HIGH */
 
#if H_DATAREADY_ACTIVE_HIGH

#define H_DR_VAL_ACTIVE (1)

#define H_DR_VAL_INACTIVE (0)

#define H_DR_INTR_EDGE (1)
 
#else /* active-low DATA_READY harness */

#define H_DR_VAL_ACTIVE   (0)

#define H_DR_VAL_INACTIVE (1)

#define H_DR_INTR_EDGE    (0)
 
#endif /* H_DATAREADY_ACTIVE_HIGH */
 
/* ----------------------------------------------------------------------- */
/* Co-processor reset polarity */
/* ----------------------------------------------------------------------- */

#define H_RESET_VAL_ACTIVE (0)

#define H_RESET_VAL_INACTIVE (1)
 
/* ----------------------------------------------------------------------- */
/* Queue depth, pooling and host identity */
/* ----------------------------------------------------------------------- */

#define H_TRANSPORT_QUEUE_SIZE (20)
 
/*
 * H_USE_MEMPOOL is DELIBERATELY LEFT UNDEFINED. Read this before adding it.
 *
 * The vendored ``host/esp_hosted_os_abstraction.h`` guards four rows of the
 * OS-abstraction vtable with ``#ifdef H_USE_MEMPOOL`` -- not ``#if``. So
 * ``#define H_USE_MEMPOOL (0)`` does NOT turn the feature off: it turns it ON
 * and grows ``hosted_osi_funcs_t`` by four function pointers. Worse, that
 * header does not include this one, so the struct would gain or lose those
 * four rows depending on whether a given translation unit happened to reach
 * this header first -- two different layouts for one type, in one image, with
 * no diagnostic from any compiler. Leaving the symbol undefined is what makes
 * the layout the same everywhere.
 *
 * Off is also the right answer on its own merits. Upstream's pool lives in
 * ``common/mempool/mempool_ll.{c,h}``, whose header includes
 * ``freertos/FreeRTOS.h``, ``portmacro.h``, ``task.h`` and ``semphr.h``
 * unconditionally -- it is a FreeRTOS data structure, and this image runs
 * ThreadX. With the symbol absent, ``transport_util.h`` routes every transport
 * buffer through ``_h_malloc_align`` instead, which this port serves from a
 * fixed ThreadX byte pool carved once during initialisation. That is the
 * bounded, allocate-once, NASA Power of 10 Rule 3 behaviour the upstream pool
 * existed to provide, one layer down.
 *
 * ``CONFIG_ESP_HOSTED_USE_MEMPOOL`` in ``idf_compat/sdkconfig.h`` is tested
 * with a bare ``#if`` and so is defined to 0 there; the two say the same
 * thing in the two different dialects their consumers use.
 */

#define H_ESP_HOSTED_HOST (1)
 
#ifndef H_ESP_PAYLOAD_HEADER_OFFSET
#define H_ESP_PAYLOAD_HEADER_OFFSET (12)
#endif /* H_ESP_PAYLOAD_HEADER_OFFSET */

#define H_SPI_FD_CLK_MHZ (5)

#define H_ENABLE (1)

#define H_DISABLE (0)
 
/* ----------------------------------------------------------------------- */
/* Remaining configuration, split by theme */
/* ----------------------------------------------------------------------- */
 
/*
 * Included last so the derivations in these files see the transport and
 * polarity selections above. A vendored translation unit that names only
 * this header still gets the complete symbol set.
 */
 
#include "port_esp_hosted_host_config_features.h"
#include "port_esp_hosted_host_config_transports.h"