Loading...
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * linux/drivers/mmc/core/core.h
4 *
5 * Copyright (C) 2003 Russell King, All Rights Reserved.
6 * Copyright 2007 Pierre Ossman
7 */
8#ifndef _MMC_CORE_CORE_H
9#define _MMC_CORE_CORE_H
10
11#include <linux/delay.h>
12#include <linux/sched.h>
13
14struct mmc_host;
15struct mmc_card;
16struct mmc_request;
17
18#define MMC_CMD_RETRIES 3
19
20struct mmc_bus_ops {
21 void (*remove)(struct mmc_host *);
22 void (*detect)(struct mmc_host *);
23 int (*pre_suspend)(struct mmc_host *);
24 int (*suspend)(struct mmc_host *);
25 int (*resume)(struct mmc_host *);
26 int (*runtime_suspend)(struct mmc_host *);
27 int (*runtime_resume)(struct mmc_host *);
28 int (*alive)(struct mmc_host *);
29 int (*shutdown)(struct mmc_host *);
30 int (*hw_reset)(struct mmc_host *);
31 int (*sw_reset)(struct mmc_host *);
32};
33
34void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops);
35void mmc_detach_bus(struct mmc_host *host);
36
37struct device_node *mmc_of_find_child_device(struct mmc_host *host,
38 unsigned func_num);
39
40void mmc_init_erase(struct mmc_card *card);
41
42void mmc_set_chip_select(struct mmc_host *host, int mode);
43void mmc_set_clock(struct mmc_host *host, unsigned int hz);
44void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode);
45void mmc_set_bus_width(struct mmc_host *host, unsigned int width);
46u32 mmc_select_voltage(struct mmc_host *host, u32 ocr);
47int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr);
48int mmc_host_set_uhs_voltage(struct mmc_host *host);
49int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage);
50void mmc_set_initial_signal_voltage(struct mmc_host *host);
51void mmc_set_timing(struct mmc_host *host, unsigned int timing);
52void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type);
53int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
54 int card_drv_type, int *drv_type);
55void mmc_power_up(struct mmc_host *host, u32 ocr);
56void mmc_power_off(struct mmc_host *host);
57void mmc_power_cycle(struct mmc_host *host, u32 ocr);
58void mmc_set_initial_state(struct mmc_host *host);
59u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
60
61static inline void mmc_delay(unsigned int ms)
62{
63 if (ms <= 20)
64 usleep_range(ms * 1000, ms * 1250);
65 else
66 msleep(ms);
67}
68
69void mmc_rescan(struct work_struct *work);
70void mmc_start_host(struct mmc_host *host);
71void mmc_stop_host(struct mmc_host *host);
72
73void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
74 bool cd_irq);
75int _mmc_detect_card_removed(struct mmc_host *host);
76int mmc_detect_card_removed(struct mmc_host *host);
77
78int mmc_attach_mmc(struct mmc_host *host);
79int mmc_attach_sd(struct mmc_host *host);
80int mmc_attach_sdio(struct mmc_host *host);
81
82/* Module parameters */
83extern bool use_spi_crc;
84
85/* Debugfs information for hosts and cards */
86void mmc_add_host_debugfs(struct mmc_host *host);
87void mmc_remove_host_debugfs(struct mmc_host *host);
88
89void mmc_add_card_debugfs(struct mmc_card *card);
90void mmc_remove_card_debugfs(struct mmc_card *card);
91
92int mmc_execute_tuning(struct mmc_card *card);
93int mmc_hs200_to_hs400(struct mmc_card *card);
94int mmc_hs400_to_hs200(struct mmc_card *card);
95
96#ifdef CONFIG_PM_SLEEP
97void mmc_register_pm_notifier(struct mmc_host *host);
98void mmc_unregister_pm_notifier(struct mmc_host *host);
99#else
100static inline void mmc_register_pm_notifier(struct mmc_host *host) { }
101static inline void mmc_unregister_pm_notifier(struct mmc_host *host) { }
102#endif
103
104void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq);
105bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
106
107int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq);
108
109int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
110 unsigned int arg);
111int mmc_can_erase(struct mmc_card *card);
112int mmc_can_trim(struct mmc_card *card);
113int mmc_can_discard(struct mmc_card *card);
114int mmc_can_sanitize(struct mmc_card *card);
115int mmc_can_secure_erase_trim(struct mmc_card *card);
116int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
117 unsigned int nr);
118unsigned int mmc_calc_max_discard(struct mmc_card *card);
119
120int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
121
122int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
123 atomic_t *abort);
124void mmc_release_host(struct mmc_host *host);
125void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
126void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
127
128/**
129 * mmc_claim_host - exclusively claim a host
130 * @host: mmc host to claim
131 *
132 * Claim a host for a set of operations.
133 */
134static inline void mmc_claim_host(struct mmc_host *host)
135{
136 __mmc_claim_host(host, NULL, NULL);
137}
138
139int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
140void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
141int mmc_cqe_recovery(struct mmc_host *host);
142
143/**
144 * mmc_pre_req - Prepare for a new request
145 * @host: MMC host to prepare command
146 * @mrq: MMC request to prepare for
147 *
148 * mmc_pre_req() is called in prior to mmc_start_req() to let
149 * host prepare for the new request. Preparation of a request may be
150 * performed while another request is running on the host.
151 */
152static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
153{
154 if (host->ops->pre_req)
155 host->ops->pre_req(host, mrq);
156}
157
158/**
159 * mmc_post_req - Post process a completed request
160 * @host: MMC host to post process command
161 * @mrq: MMC request to post process for
162 * @err: Error, if non zero, clean up any resources made in pre_req
163 *
164 * Let the host post process a completed request. Post processing of
165 * a request may be performed while another request is running.
166 */
167static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
168 int err)
169{
170 if (host->ops->post_req)
171 host->ops->post_req(host, mrq, err);
172}
173
174#endif
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * linux/drivers/mmc/core/core.h
4 *
5 * Copyright (C) 2003 Russell King, All Rights Reserved.
6 * Copyright 2007 Pierre Ossman
7 */
8#ifndef _MMC_CORE_CORE_H
9#define _MMC_CORE_CORE_H
10
11#include <linux/delay.h>
12#include <linux/sched.h>
13
14struct mmc_host;
15struct mmc_card;
16struct mmc_request;
17
18#define MMC_CMD_RETRIES 3
19
20struct mmc_bus_ops {
21 void (*remove)(struct mmc_host *);
22 void (*detect)(struct mmc_host *);
23 int (*pre_suspend)(struct mmc_host *);
24 int (*suspend)(struct mmc_host *);
25 int (*resume)(struct mmc_host *);
26 int (*runtime_suspend)(struct mmc_host *);
27 int (*runtime_resume)(struct mmc_host *);
28 int (*alive)(struct mmc_host *);
29 int (*shutdown)(struct mmc_host *);
30 int (*hw_reset)(struct mmc_host *);
31 int (*sw_reset)(struct mmc_host *);
32 bool (*cache_enabled)(struct mmc_host *);
33 int (*flush_cache)(struct mmc_host *);
34};
35
36void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops);
37void mmc_detach_bus(struct mmc_host *host);
38
39struct device_node *mmc_of_find_child_device(struct mmc_host *host,
40 unsigned func_num);
41
42void mmc_init_erase(struct mmc_card *card);
43
44void mmc_set_chip_select(struct mmc_host *host, int mode);
45void mmc_set_clock(struct mmc_host *host, unsigned int hz);
46void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode);
47void mmc_set_bus_width(struct mmc_host *host, unsigned int width);
48u32 mmc_select_voltage(struct mmc_host *host, u32 ocr);
49int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr);
50int mmc_host_set_uhs_voltage(struct mmc_host *host);
51int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage);
52void mmc_set_initial_signal_voltage(struct mmc_host *host);
53void mmc_set_timing(struct mmc_host *host, unsigned int timing);
54void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type);
55int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
56 int card_drv_type, int *drv_type);
57void mmc_power_up(struct mmc_host *host, u32 ocr);
58void mmc_power_off(struct mmc_host *host);
59void mmc_power_cycle(struct mmc_host *host, u32 ocr);
60void mmc_set_initial_state(struct mmc_host *host);
61u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max);
62
63static inline void mmc_delay(unsigned int ms)
64{
65 if (ms <= 20)
66 usleep_range(ms * 1000, ms * 1250);
67 else
68 msleep(ms);
69}
70
71void mmc_rescan(struct work_struct *work);
72void mmc_start_host(struct mmc_host *host);
73void mmc_stop_host(struct mmc_host *host);
74
75void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
76 bool cd_irq);
77int _mmc_detect_card_removed(struct mmc_host *host);
78int mmc_detect_card_removed(struct mmc_host *host);
79
80int mmc_attach_mmc(struct mmc_host *host);
81int mmc_attach_sd(struct mmc_host *host);
82int mmc_attach_sdio(struct mmc_host *host);
83
84/* Module parameters */
85extern bool use_spi_crc;
86
87/* Debugfs information for hosts and cards */
88void mmc_add_host_debugfs(struct mmc_host *host);
89void mmc_remove_host_debugfs(struct mmc_host *host);
90
91void mmc_add_card_debugfs(struct mmc_card *card);
92void mmc_remove_card_debugfs(struct mmc_card *card);
93
94int mmc_execute_tuning(struct mmc_card *card);
95int mmc_hs200_to_hs400(struct mmc_card *card);
96int mmc_hs400_to_hs200(struct mmc_card *card);
97
98void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq);
99bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq);
100
101int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq);
102
103int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
104 unsigned int arg);
105int mmc_can_erase(struct mmc_card *card);
106int mmc_can_trim(struct mmc_card *card);
107int mmc_can_discard(struct mmc_card *card);
108int mmc_can_sanitize(struct mmc_card *card);
109int mmc_can_secure_erase_trim(struct mmc_card *card);
110int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
111 unsigned int nr);
112unsigned int mmc_calc_max_discard(struct mmc_card *card);
113
114int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen);
115
116int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
117 atomic_t *abort);
118void mmc_release_host(struct mmc_host *host);
119void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx);
120void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx);
121
122/**
123 * mmc_claim_host - exclusively claim a host
124 * @host: mmc host to claim
125 *
126 * Claim a host for a set of operations.
127 */
128static inline void mmc_claim_host(struct mmc_host *host)
129{
130 __mmc_claim_host(host, NULL, NULL);
131}
132
133int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq);
134void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq);
135int mmc_cqe_recovery(struct mmc_host *host);
136
137/**
138 * mmc_pre_req - Prepare for a new request
139 * @host: MMC host to prepare command
140 * @mrq: MMC request to prepare for
141 *
142 * mmc_pre_req() is called in prior to mmc_start_req() to let
143 * host prepare for the new request. Preparation of a request may be
144 * performed while another request is running on the host.
145 */
146static inline void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
147{
148 if (host->ops->pre_req)
149 host->ops->pre_req(host, mrq);
150}
151
152/**
153 * mmc_post_req - Post process a completed request
154 * @host: MMC host to post process command
155 * @mrq: MMC request to post process for
156 * @err: Error, if non zero, clean up any resources made in pre_req
157 *
158 * Let the host post process a completed request. Post processing of
159 * a request may be performed while another request is running.
160 */
161static inline void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
162 int err)
163{
164 if (host->ops->post_req)
165 host->ops->post_req(host, mrq, err);
166}
167
168static inline bool mmc_cache_enabled(struct mmc_host *host)
169{
170 if (host->bus_ops->cache_enabled)
171 return host->bus_ops->cache_enabled(host);
172
173 return false;
174}
175
176static inline int mmc_flush_cache(struct mmc_host *host)
177{
178 if (host->bus_ops->flush_cache)
179 return host->bus_ops->flush_cache(host);
180
181 return 0;
182}
183
184#endif