79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
68 lines
1.2 KiB
C
68 lines
1.2 KiB
C
/*
|
|
* Copyright 2022 NXP
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Common utility functions for SD subsystem
|
|
*/
|
|
|
|
#ifndef ZEPHYR_SUBSYS_SD_UTILS_H_
|
|
#define ZEPHYR_SUBSYS_SD_UTILS_H_
|
|
|
|
#include <zephyr/kernel.h>
|
|
#include <zephyr/sd/sd.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Custom SD return codes. Used internally to indicate conditions that may
|
|
* not be errors, but are abnormal return conditions
|
|
*/
|
|
enum sd_return_codes {
|
|
SD_RETRY = 1,
|
|
SD_NOT_SDIO = 2,
|
|
SD_RESTART = 3,
|
|
};
|
|
|
|
/* Delay function for SD subsystem */
|
|
static inline void sd_delay(unsigned int millis)
|
|
{
|
|
k_msleep(millis);
|
|
}
|
|
|
|
/*
|
|
* Helper function to retry sending command to SD card
|
|
* Will retry command if return code equals SD_RETRY
|
|
*/
|
|
static inline int sd_retry(int(*cmd)(struct sd_card *card),
|
|
struct sd_card *card,
|
|
int retries)
|
|
{
|
|
int ret = -ETIMEDOUT;
|
|
|
|
while (retries-- >= 0) {
|
|
/* Try cmd */
|
|
ret = cmd(card);
|
|
/**
|
|
* Functions have 3 possible responses:
|
|
* 0: success
|
|
* SD_RETRY: retry command
|
|
* other: does not retry
|
|
*/
|
|
if (ret != SD_RETRY) {
|
|
break;
|
|
}
|
|
}
|
|
return ret == SD_RETRY ? -ETIMEDOUT : ret;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZEPHYR_SUBSYS_SD_UTILS_H_ */
|