Re: [PATCH v2 10/14] mci: mci-core: add HS200 support

[Ahmad Fatoum <a.fatoum@pengutronix.de>]

On 14.03.24 19:47, Steffen Trumtrar wrote:
> HS200 is a timing mode for eMMCs to work 8bit with 200MHz clocks.
> To be used, drivers need to set the correct drive strength, clock phases
> and then SDHCI can start tuning for HS200.
> 
> Signed-off-by: Steffen Trumtrar <s.trumtrar@pengutronix.de>

Acked-by: Ahmad Fatoum <a.fatoum@pengutronix.de>

> ---
>  drivers/mci/Kconfig    |   7 ++
>  drivers/mci/mci-core.c | 257 +++++++++++++++++++++++++++++++++++++++++++++++--
>  include/mci.h          |  42 +++++++-
>  3 files changed, 294 insertions(+), 12 deletions(-)
> 
> diff --git a/drivers/mci/Kconfig b/drivers/mci/Kconfig
> index f569e24c0d..1e8c85643b 100644
> --- a/drivers/mci/Kconfig
> +++ b/drivers/mci/Kconfig
> @@ -12,6 +12,13 @@ if MCI
>  
>  comment "--- Feature list ---"
>  
> +config MCI_TUNING
> +	bool "EXPERIMENTAL - support MMC tuning for higher speeds"
> +	help
> +	  Say 'y' here if supporting drivers should do tuning to support
> +	  higher clock speeds than 52 MHz SDR. MMC only; SD-Card max
> +	  frequency is 50MHz SDR at present.
> +
>  config MCI_STARTUP
>  	bool "Force probe on system start"
>  	help
> diff --git a/drivers/mci/mci-core.c b/drivers/mci/mci-core.c
> index 3e078862f2..e825c91c80 100644
> --- a/drivers/mci/mci-core.c
> +++ b/drivers/mci/mci-core.c
> @@ -168,6 +168,35 @@ static int mci_send_status(struct mci *mci, unsigned int *status)
>  	return ret;
>  }
>  
> +static int mmc_switch_status_error(struct mci_host *host, u32 status)
> +{
> +	if (mmc_host_is_spi(host)) {
> +		if (status & R1_SPI_ILLEGAL_COMMAND)
> +			return -EBADMSG;
> +	} else {
> +		if (R1_STATUS(status))
> +			pr_warn("unexpected status %#x after switch\n", status);
> +		if (status & R1_SWITCH_ERROR)
> +			return -EBADMSG;
> +	}
> +	return 0;
> +}
> +
> +/* Caller must hold re-tuning */
> +int mci_switch_status(struct mci *mci, bool crc_err_fatal)
> +{
> +	u32 status;
> +	int err;
> +
> +	err = mci_send_status(mci, &status);
> +	if (!crc_err_fatal && err == -EILSEQ)
> +		return 0;
> +	if (err)
> +		return err;
> +
> +	return mmc_switch_status_error(mci->host, status);
> +}
> +
>  static int mci_poll_until_ready(struct mci *mci, int timeout_ms)
>  {
>  	unsigned int status;
> @@ -1230,6 +1259,17 @@ static int mci_mmc_try_bus_width(struct mci *mci, enum mci_bus_width bus_width,
>  	mci->host->timing = timing;
>  	mci_set_bus_width(mci, bus_width);
>  
> +	switch (bus_width) {
> +		case MMC_BUS_WIDTH_8:
> +			mci->card_caps |= MMC_CAP_8_BIT_DATA;
> +			break;
> +		case MMC_BUS_WIDTH_4:
> +			mci->card_caps |= MMC_CAP_4_BIT_DATA;
> +			break;
> +		default:
> +			break;
> +	}
> +
>  	err = mmc_compare_ext_csds(mci, bus_width);
>  	if (err < 0)
>  		goto out;
> @@ -1303,10 +1343,192 @@ static int mci_mmc_select_hs_ddr(struct mci *mci)
>  	return 0;
>  }
>  
> +int mci_execute_tuning(struct mci *mci)
> +{
> +	struct mci_host *host = mci->host;
> +	u32 opcode;
> +
> +	if (!host->execute_tuning)
> +		return 0;
> +
> +	/* Tuning is only supported for MMC / HS200 */
> +	if (mmc_card_hs200(mci))
> +		opcode = MMC_SEND_TUNING_BLOCK_HS200;
> +	else
> +		return 0;
> +
> +	return host->execute_tuning(host, opcode);
> +}
> +
> +int mci_send_abort_tuning(struct mci *mci, u32 opcode)
> +{
> +	struct mci_cmd cmd = {};
> +
> +	/*
> +	 * eMMC specification specifies that CMD12 can be used to stop a tuning
> +	 * command, but SD specification does not, so do nothing unless it is
> +	 * eMMC.
> +	 */
> +	if (opcode != MMC_SEND_TUNING_BLOCK_HS200)
> +		return 0;
> +
> +	cmd.cmdidx = MMC_CMD_STOP_TRANSMISSION;
> +	cmd.resp_type = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
> +
> +	return mci_send_cmd(mci, &cmd, NULL);
> +}
> +EXPORT_SYMBOL_GPL(mci_send_abort_tuning);
> +
> +static void mmc_select_max_dtr(struct mci *mci)
> +{
> +	u8 card_type = mci->ext_csd[EXT_CSD_DEVICE_TYPE];
> +	u32 caps2 = mci->host->caps2;
> +	u32 caps = mci->card_caps;
> +	unsigned int hs_max_dtr = 0;
> +	unsigned int hs200_max_dtr = 0;
> +
> +	if ((caps & MMC_CAP_MMC_HIGHSPEED) &&
> +	    (card_type & EXT_CSD_CARD_TYPE_26)) {
> +		hs_max_dtr = MMC_HIGH_26_MAX_DTR;
> +	}
> +
> +	if ((caps & MMC_CAP_MMC_HIGHSPEED) &&
> +	    (card_type & EXT_CSD_CARD_TYPE_52)) {
> +		hs_max_dtr = MMC_HIGH_52_MAX_DTR;
> +	}
> +
> +	if ((caps2 & MMC_CAP2_HS200_1_8V_SDR) &&
> +	    (card_type & EXT_CSD_CARD_TYPE_HS200_1_8V)) {
> +		hs200_max_dtr = MMC_HS200_MAX_DTR;
> +	}
> +
> +	if ((caps2 & MMC_CAP2_HS200_1_2V_SDR) &&
> +	    (card_type & EXT_CSD_CARD_TYPE_HS200_1_2V)) {
> +		hs200_max_dtr = MMC_HS200_MAX_DTR;
> +	}
> +
> +	mci->host->hs200_max_dtr = hs200_max_dtr;
> +	mci->host->hs_max_dtr = hs_max_dtr;
> +}
> +/*
> + * For device supporting HS200 mode, the following sequence
> + * should be done before executing the tuning process.
> + * 1. set the desired bus width(4-bit or 8-bit, 1-bit is not supported)
> + * 2. switch to HS200 mode
> + * 3. set the clock to > 52Mhz and <=200MHz
> + */
> +static int mmc_select_hs200(struct mci *mci)
> +{
> +	unsigned int old_timing, old_clock;
> +	int err = -EINVAL;
> +	u8 val;
> +
> +	/*
> +	 * Set the bus width(4 or 8) with host's support and
> +	 * switch to HS200 mode if bus width is set successfully.
> +	 */
> +	/* find out maximum bus width and then try DDR if supported */
> +	err = mci_mmc_select_bus_width(mci);
> +	if (err > 0) {
> +		u32 status;
> +
> +		/* TODO  actually set drive strength instead of 0. Currently unsupported. */
> +		val = EXT_CSD_TIMING_HS200 | 0 << EXT_CSD_DRV_STR_SHIFT;
> +		err = mci_switch(mci, EXT_CSD_HS_TIMING, val);
> +		if (err)
> +			goto err;
> +
> +		/*
> +		 * Bump to HS timing and frequency. Some cards don't handle
> +		 * SEND_STATUS reliably at the initial frequency.
> +		 * NB: We can't move to full (HS200) speeds until after we've
> +		 * successfully switched over.
> +		 */
> +		old_timing = mci->host->timing;
> +		old_clock = mci->host->clock;
> +
> +		mci->host->timing = MMC_TIMING_MMC_HS200;
> +		mci_set_ios(mci);
> +		mci_set_clock(mci, mci->host->hs_max_dtr);
> +
> +		err = mci_switch_status(mci, &status);
> +
> +		/*
> +		 * mmc_select_timing() assumes timing has not changed if
> +		 * it is a switch error.
> +		 */
> +		if (err == -EBADMSG) {
> +			mci->host->clock = old_clock;
> +			mci->host->timing = old_timing;
> +			mci_set_ios(mci);
> +		}
> +	}
> +err:
> +	if (err) {
> +		dev_err(&mci->dev, "%s failed, error %d\n", __func__, err);
> +	}
> +	return err;
> +}
> +
> +/*
> + * Set the bus speed for the selected speed mode.
> + */
> +static void mmc_set_bus_speed(struct mci *mci)
> +{
> +	unsigned int max_dtr = (unsigned int)-1;
> +
> +	if (mmc_card_hs200(mci) &&
> +		max_dtr > mci->host->hs200_max_dtr)
> +		max_dtr = mci->host->hs200_max_dtr;
> +	else if (mmc_card_hs(mci) && max_dtr > mci->host->hs_max_dtr)
> +		max_dtr = mci->host->hs_max_dtr;
> +	else if (max_dtr > mci->tran_speed)
> +		max_dtr = mci->tran_speed;
> +
> +	mci_set_clock(mci, max_dtr);
> +}
> +
> +/*
> + * Activate HS200 or HS400ES mode if supported.
> + */
> +int mmc_select_timing(struct mci *mci)
> +{
> +	unsigned int mmc_avail_type;
> +	int err = 0;
> +
> +	mmc_select_max_dtr(mci);
> +
> +	mmc_avail_type = mci->ext_csd[EXT_CSD_DEVICE_TYPE] & EXT_CSD_CARD_TYPE_MASK;
> +	if (mmc_avail_type & EXT_CSD_CARD_TYPE_HS200) {
> +		err = mmc_select_hs200(mci);
> +		if (err == -EBADMSG)
> +			mmc_avail_type &= ~EXT_CSD_CARD_TYPE_HS200;
> +		else
> +			goto out;
> +	}
> +
> +out:
> +	if (err && err != -EBADMSG)
> +		return err;
> +
> +	/*
> +	 * Set the bus speed to the selected bus timing.
> +	 * If timing is not selected, backward compatible is the default.
> +	 */
> +	mmc_set_bus_speed(mci);
> +
> +	return 0;
> +}
> +
> +int mmc_hs200_tuning(struct mci *mci)
> +{
> +	return mci_execute_tuning(mci);
> +}
> +
>  static int mci_startup_mmc(struct mci *mci)
>  {
>  	struct mci_host *host = mci->host;
> -	int ret;
> +	int ret = 0;
>  
>  	/* if possible, speed up the transfer */
>  	if (mci_caps(mci) & MMC_CAP_MMC_HIGHSPEED) {
> @@ -1318,19 +1540,32 @@ static int mci_startup_mmc(struct mci *mci)
>  		host->timing = MMC_TIMING_MMC_HS;
>  	}
>  
> -	mci_set_clock(mci, mci->tran_speed);
> +	if (IS_ENABLED(CONFIG_MCI_TUNING)) {
> +		/*
> +		 * Select timing interface
> +		 */
> +		ret = mmc_select_timing(mci);
> +		if (ret)
> +			return ret;
>  
> -	/* find out maximum bus width and then try DDR if supported */
> -	ret = mci_mmc_select_bus_width(mci);
> -	if (ret > MMC_BUS_WIDTH_1 && mci->tran_speed == 52000000)
> -		ret = mci_mmc_select_hs_ddr(mci);
> +		if (mmc_card_hs200(mci))
> +			ret = mmc_hs200_tuning(mci);
> +	}
>  
> -	if (ret < 0) {
> -		dev_warn(&mci->dev, "Changing MMC bus width failed: %d\n", ret);
> -		return ret;
> +	if (ret || !IS_ENABLED(CONFIG_MCI_TUNING)) {
> +		mci_set_clock(mci, mci->tran_speed);
> +
> +		/* find out maximum bus width and then try DDR if supported */
> +		ret = mci_mmc_select_bus_width(mci);
> +		if (ret > MMC_BUS_WIDTH_1 && mci->tran_speed == 52000000)
> +			ret = mci_mmc_select_hs_ddr(mci);
> +
> +		if (ret < 0) {
> +			dev_warn(&mci->dev, "Changing MMC bus width failed: %d\n", ret);
> +		}
>  	}
>  
> -	return 0;
> +	return ret;
>  }
>  
>  /**
> @@ -1758,6 +1993,8 @@ static const char *mci_timing_tostr(unsigned timing)
>  		return "SD HS";
>  	case MMC_TIMING_MMC_DDR52:
>  		return "MMC DDR52";
> +	case MMC_TIMING_MMC_HS200:
> +		return "HS200";
>  	default:
>  		return "unknown"; /* shouldn't happen */
>  	}
> diff --git a/include/mci.h b/include/mci.h
> index 7a4521adde..52bf84ecdb 100644
> --- a/include/mci.h
> +++ b/include/mci.h
> @@ -82,6 +82,8 @@
>  #define MMC_CMD_SET_BLOCKLEN		16
>  #define MMC_CMD_READ_SINGLE_BLOCK	17
>  #define MMC_CMD_READ_MULTIPLE_BLOCK	18
> +#define MMC_SEND_TUNING_BLOCK		19   /* adtc R1  */
> +#define MMC_SEND_TUNING_BLOCK_HS200	21   /* adtc R1  */
>  #define MMC_CMD_WRITE_SINGLE_BLOCK	24
>  #define MMC_CMD_WRITE_MULTIPLE_BLOCK	25
>  #define MMC_CMD_APP_CMD			55
> @@ -293,8 +295,8 @@
>  #define EXT_CSD_CARD_TYPE_MASK		0x3f
>  #define EXT_CSD_CARD_TYPE_26		(1<<0)	/* Card can run at 26MHz */
>  #define EXT_CSD_CARD_TYPE_52		(1<<1)	/* Card can run at 52MHz */
> -#define EXT_CSD_CARD_TYPE_HS		(EXT_CSD_CARD_TYPE_HS_26 |	\
> -					 EXT_CSD_CARD_TYPE_HS_52)
> +#define EXT_CSD_CARD_TYPE_HS		(EXT_CSD_CARD_TYPE_26 |	\
> +					 EXT_CSD_CARD_TYPE_52)
>  #define EXT_CSD_CARD_TYPE_DDR_1_8V	(1<<2)	/* Card can run at 52MHz */
>  						/* DDR mode @1.8V or 3V I/O */
>  #define EXT_CSD_CARD_TYPE_DDR_1_2V	(1<<3)	/* Card can run at 52MHz */
> @@ -330,6 +332,12 @@
>  #define EXT_CSD_DDR_BUS_WIDTH_8	6	/* Card is in 8 bit DDR mode */
>  #define EXT_CSD_DDR_FLAG	BIT(2)	/* Flag for DDR mode */
>  
> +#define EXT_CSD_TIMING_BC	0	/* Backwards compatility */
> +#define EXT_CSD_TIMING_HS	1	/* High speed */
> +#define EXT_CSD_TIMING_HS200	2	/* HS200 */
> +#define EXT_CSD_TIMING_HS400	3	/* HS400 */
> +#define EXT_CSD_DRV_STR_SHIFT	4	/* Driver Strength shift */
> +
>  #define R1_ILLEGAL_COMMAND		(1 << 22)
>  #define R1_STATUS(x)			(x & 0xFFF9A000)
>  #define R1_CURRENT_STATE(x)		((x & 0x00001E00) >> 9)	/* sx, b (4 bits) */
> @@ -504,6 +512,8 @@ struct mci_host {
>  	unsigned actual_clock;
>  	enum mci_bus_width bus_width;	/**< used data bus width to the card */
>  	enum mci_timing timing;	/**< used timing specification to the card */
> +	unsigned hs_max_dtr;
> +	unsigned hs200_max_dtr;
>  	unsigned max_req_size;
>  	unsigned dsr_val;	/**< optional dsr value */
>  	int use_dsr;		/**< optional dsr usage flag */
> @@ -522,6 +532,8 @@ struct mci_host {
>  	int (*card_present)(struct mci_host *);
>  	/** check if a card is write protected */
>  	int (*card_write_protected)(struct mci_host *);
> +	/* The tuning command opcode value is different for SD and eMMC cards */
> +	int (*execute_tuning)(struct mci_host *, u32);
>  };
>  
>  #define MMC_NUM_BOOT_PARTITION	2
> @@ -587,6 +599,7 @@ void mci_of_parse_node(struct mci_host *host, struct device_node *np);
>  int mci_detect_card(struct mci_host *);
>  int mci_send_ext_csd(struct mci *mci, char *ext_csd);
>  int mci_switch(struct mci *mci, unsigned index, unsigned value);
> +int mci_switch_status(struct mci *mci, bool crc_err_fatal);
>  u8 *mci_get_ext_csd(struct mci *mci);
>  
>  static inline int mmc_host_is_spi(struct mci_host *host)
> @@ -604,4 +617,29 @@ static inline struct mci *mci_get_device_by_devpath(const char *devpath)
>  	return mci_get_device_by_name(devpath_to_name(devpath));
>  }
>  
> +#define MMC_HIGH_26_MAX_DTR	26000000
> +#define MMC_HIGH_52_MAX_DTR	52000000
> +#define MMC_HIGH_DDR_MAX_DTR	52000000
> +#define MMC_HS200_MAX_DTR	200000000
> +
> +static inline int mmc_card_hs(struct mci *mci)
> +{
> +	return mci->host->timing == MMC_TIMING_SD_HS ||
> +		mci->host->timing == MMC_TIMING_MMC_HS;
> +}
> +
> +/*
> + * Execute tuning sequence to seek the proper bus operating
> + * conditions for HS200 and HS400, which sends CMD21 to the device.
> + */
> +int mmc_hs200_tuning(struct mci *mci);
> +int mci_execute_tuning(struct mci *mci);
> +int mci_send_abort_tuning(struct mci *mci, u32 opcode);
> +int mmc_select_timing(struct mci *mci);
> +
> +static inline bool mmc_card_hs200(struct mci *mci)
> +{
> +	return mci->host->timing == MMC_TIMING_MMC_HS200;
> +}
> +
>  #endif /* _MCI_H_ */
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |