xref: /freebsd/sys/dev/sdio/sdio_subr.h (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*-
2  * Copyright (c) 2017 Ilya Bakulin.  All rights reserved.
3  * Copyright (c) 2018-2019 The FreeBSD Foundation
4  *
5  * Portions of this software were developed by Björn Zeeb
6  * under sponsorship from the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  *
29  * Portions of this software may have been developed with reference to
30  * the SD Simplified Specification.  The following disclaimer may apply:
31  *
32  * The following conditions apply to the release of the simplified
33  * specification ("Simplified Specification") by the SD Card Association and
34  * the SD Group. The Simplified Specification is a subset of the complete SD
35  * Specification which is owned by the SD Card Association and the SD
36  * Group. This Simplified Specification is provided on a non-confidential
37  * basis subject to the disclaimers below. Any implementation of the
38  * Simplified Specification may require a license from the SD Card
39  * Association, SD Group, SD-3C LLC or other third parties.
40  *
41  * Disclaimers:
42  *
43  * The information contained in the Simplified Specification is presented only
44  * as a standard specification for SD Cards and SD Host/Ancillary products and
45  * is provided "AS-IS" without any representations or warranties of any
46  * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
47  * Card Association for any damages, any infringements of patents or other
48  * right of the SD Group, SD-3C LLC, the SD Card Association or any third
49  * parties, which may result from its use. No license is granted by
50  * implication, estoppel or otherwise under any patent or other rights of the
51  * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
52  * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
53  * or the SD Card Association to disclose or distribute any technical
54  * information, know-how or other confidential information to any third party.
55  *
56  *
57  * $FreeBSD$
58  */
59 
60 #ifndef _SDIO_SUBR_H_
61 #define _SDIO_SUBR_H_
62 
63 /*
64  * This file contains structures and functions to work with SDIO cards.
65  */
66 
67 struct sdio_func {
68 	device_t	dev;		/* The device to talk to CAM. */
69 	uintptr_t	drvdata;	/* Driver specific data. */
70 
71 	uint8_t		fn;		/* Function number. */
72 
73 	uint8_t		class;		/* Class of function. */
74 	uint16_t	vendor;		/* Manufacturer ID. */
75 	uint16_t	device;		/* Card ID. */
76 
77 	uint16_t	max_blksize;	/* Maximum block size of function. */
78 	uint16_t	cur_blksize;	/* Current block size of function. */
79 
80 	uint16_t	retries;	/* Retires for CAM operations. */
81 	uint32_t	timeout;	/* Timeout. */
82 };
83 
84 struct card_info {
85 	struct sdio_func f[8];
86 
87 	/* Compared to R4 Number of I/O Functions we DO count F0 here. */
88 	uint8_t		num_funcs;
89 
90 	bool		support_multiblk; /* Support Multiple Block Transfer */
91 };
92 
93 #ifdef _KERNEL
94 int sdio_enable_func(struct sdio_func *);
95 int sdio_disable_func(struct sdio_func *);
96 int sdio_set_block_size(struct sdio_func *, uint16_t);
97 
98 uint8_t sdio_read_1(struct sdio_func *, uint32_t, int *);
99 void sdio_write_1(struct sdio_func *, uint32_t, uint8_t, int *);
100 uint32_t sdio_read_4(struct sdio_func *, uint32_t, int *);
101 void sdio_write_4(struct sdio_func *, uint32_t, uint32_t, int *);
102 
103 uint8_t sdio_f0_read_1(struct sdio_func *, uint32_t, int *);
104 void sdio_f0_write_1(struct sdio_func *, uint32_t, uint8_t, int *);
105 #endif /* _KERNEL */
106 
107 #endif /* _SDIO_SUBR_H_ */
108