xref: /linux-6.15/include/linux/mmc/card.h (revision 87c2ce3b)
1 /*
2  *  linux/include/linux/mmc/card.h
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  *  Card driver specific definitions.
9  */
10 #ifndef LINUX_MMC_CARD_H
11 #define LINUX_MMC_CARD_H
12 
13 #include <linux/mmc/mmc.h>
14 
15 struct mmc_cid {
16 	unsigned int		manfid;
17 	char			prod_name[8];
18 	unsigned int		serial;
19 	unsigned short		oemid;
20 	unsigned short		year;
21 	unsigned char		hwrev;
22 	unsigned char		fwrev;
23 	unsigned char		month;
24 };
25 
26 struct mmc_csd {
27 	unsigned char		mmca_vsn;
28 	unsigned short		cmdclass;
29 	unsigned short		tacc_clks;
30 	unsigned int		tacc_ns;
31 	unsigned int		max_dtr;
32 	unsigned int		read_blkbits;
33 	unsigned int		write_blkbits;
34 	unsigned int		capacity;
35 	unsigned int		read_partial:1,
36 				read_misalign:1,
37 				write_partial:1,
38 				write_misalign:1;
39 };
40 
41 struct sd_scr {
42 	unsigned char		sda_vsn;
43 	unsigned char		bus_widths;
44 #define SD_SCR_BUS_WIDTH_1	(1<<0)
45 #define SD_SCR_BUS_WIDTH_4	(1<<2)
46 };
47 
48 struct mmc_host;
49 
50 /*
51  * MMC device
52  */
53 struct mmc_card {
54 	struct list_head	node;		/* node in hosts devices list */
55 	struct mmc_host		*host;		/* the host this device belongs to */
56 	struct device		dev;		/* the device */
57 	unsigned int		rca;		/* relative card address of device */
58 	unsigned int		state;		/* (our) card state */
59 #define MMC_STATE_PRESENT	(1<<0)		/* present in sysfs */
60 #define MMC_STATE_DEAD		(1<<1)		/* device no longer in stack */
61 #define MMC_STATE_BAD		(1<<2)		/* unrecognised device */
62 #define MMC_STATE_SDCARD	(1<<3)		/* is an SD card */
63 #define MMC_STATE_READONLY	(1<<4)		/* card is read-only */
64 	u32			raw_cid[4];	/* raw card CID */
65 	u32			raw_csd[4];	/* raw card CSD */
66 	u32			raw_scr[2];	/* raw card SCR */
67 	struct mmc_cid		cid;		/* card identification */
68 	struct mmc_csd		csd;		/* card specific */
69 	struct sd_scr		scr;		/* extra SD information */
70 };
71 
72 #define mmc_card_present(c)	((c)->state & MMC_STATE_PRESENT)
73 #define mmc_card_dead(c)	((c)->state & MMC_STATE_DEAD)
74 #define mmc_card_bad(c)		((c)->state & MMC_STATE_BAD)
75 #define mmc_card_sd(c)		((c)->state & MMC_STATE_SDCARD)
76 #define mmc_card_readonly(c)	((c)->state & MMC_STATE_READONLY)
77 
78 #define mmc_card_set_present(c)	((c)->state |= MMC_STATE_PRESENT)
79 #define mmc_card_set_dead(c)	((c)->state |= MMC_STATE_DEAD)
80 #define mmc_card_set_bad(c)	((c)->state |= MMC_STATE_BAD)
81 #define mmc_card_set_sd(c)	((c)->state |= MMC_STATE_SDCARD)
82 #define mmc_card_set_readonly(c) ((c)->state |= MMC_STATE_READONLY)
83 
84 #define mmc_card_name(c)	((c)->cid.prod_name)
85 #define mmc_card_id(c)		((c)->dev.bus_id)
86 
87 #define mmc_list_to_card(l)	container_of(l, struct mmc_card, node)
88 #define mmc_get_drvdata(c)	dev_get_drvdata(&(c)->dev)
89 #define mmc_set_drvdata(c,d)	dev_set_drvdata(&(c)->dev, d)
90 
91 /*
92  * MMC device driver (e.g., Flash card, I/O card...)
93  */
94 struct mmc_driver {
95 	struct device_driver drv;
96 	int (*probe)(struct mmc_card *);
97 	void (*remove)(struct mmc_card *);
98 	int (*suspend)(struct mmc_card *, pm_message_t);
99 	int (*resume)(struct mmc_card *);
100 };
101 
102 extern int mmc_register_driver(struct mmc_driver *);
103 extern void mmc_unregister_driver(struct mmc_driver *);
104 
105 static inline int mmc_card_claim_host(struct mmc_card *card)
106 {
107 	return __mmc_claim_host(card->host, card);
108 }
109 
110 #define mmc_card_release_host(c)	mmc_release_host((c)->host)
111 
112 #endif
113