summaryrefslogtreecommitdiff
path: root/memories/sdmmc/sdspi.h
blob: 9f267ecbcc69f501abb8ecd5c817eaa1d3c62c24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/* ----------------------------------------------------------------------------
 *         ATMEL Microcontroller Software Support
 * ----------------------------------------------------------------------------
 * Copyright (c) 2008, Atmel Corporation

 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the disclaimer below.
 *
 * Atmel's name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ----------------------------------------------------------------------------
 */

//------------------------------------------------------------------------------
/// \page "sdspi"
///
/// !Purpose
///  
/// sdcard spi-bus driver
///
/// !Usage
///
/// -# SDSPI_Configure: Initializes the SD Spi structure and the corresponding SPI hardware
/// -# SDSPI_ConfigureCS : Configures the parameters for the device corresponding to the cs
/// -# SDSPI_Read: Read data on SPI data bus
/// -# SDSPI_Write : Write data on SPI data bus
/// -# SDSPI_SendCommand : Starts a SPI master transfer
/// -# SDSPI_StopTranToken : Send stop transfer data token
//------------------------------------------------------------------------------

#ifndef SDSPI_H
#define SDSPI_H

//------------------------------------------------------------------------------
//         Headers
//------------------------------------------------------------------------------

#include <board.h>
#include <spi/spi.h>

#define SDSPI_SUCCESS       0
#define SDSPI_ERROR         1
#define SDSPI_NO_RESPONSE   2
#define SDSPI_BUSY          4

// Data Response Token RC
#define SDSPI_DATA_NO_RESP  0x1
#define SDSPI_DATA_ACCEPTED 0x5
#define SDSPI_DATA_CRC_ERR  0xB
#define SDSPI_DATA_WR_ERR   0xD

/// SPI CSR value
//#define SDSPI_CSR(scbr) ( AT91C_SPI_CPOL  \
//                        | AT91C_SPI_BITS_8 \
//                        | (((scbr)<<  8) & AT91C_SPI_SCBR) \
//                        | ( (0x08 << 16) & AT91C_SPI_DLYBS)\
//                        | ( (0x01 << 24) & AT91C_SPI_DLYBCT) )

/// Calculates the value of the SCBR field of the Chip Select Register given
/// MCK and SPCK.
#define SPID_CSR_SCBR(mck, spck)    ((((mck) / (spck)) << 8) & AT91C_SPI_SCBR)

/// Calculates the value of the DLYBS field of the Chip Select Register given
/// the delay in ns and MCK.
#define SPID_CSR_DLYBS(mck, delay) \
    ((((((delay) * ((mck) / 1000000)) / 1000) + 1)  << 16) & AT91C_SPI_DLYBS)

/// Calculates the value of the DLYBCT field of the Chip Select Register given
/// the delay in ns and MCK.
#define SPID_CSR_DLYBCT(mck, delay) \
    ((((((delay) / 32 * ((mck) / 1000000)) / 1000) + 1) << 24) & AT91C_SPI_DLYBCT)

#define SDSPI_CSR(mck, spck) \
    (AT91C_SPI_NCPHA | SPID_CSR_DLYBCT(mck, 20) \
     | SPID_CSR_DLYBS(mck, 20) | SPID_CSR_SCBR(mck, spck) \
     | 0 /*AT91C_SPI_CSAAT*/ \
    )


/// Start new data transfer
#define SPI_NEW_TRANSFER        0
/// Continue data transfer
#define SPI_CONTINUE_TRANSFER   1

/// SD end-of-transfer callback function.
typedef void (*SdSpiCallback)(unsigned char status, void *pCommand);

//------------------------------------------------------------------------------
/// SPI Transfer Request prepared by the application upper layer. This structure
/// is sent to the SDSPI_SendCommand function to start the transfer. At the end of
/// the transfer, the callback is invoked by the interrupt handler.
//------------------------------------------------------------------------------
typedef struct _SdSpiCmd {

    /// Command status.
    volatile char status;
    /// Command code.
    unsigned int cmd;
    /// Command argument.
    unsigned int arg;
    /// Data buffer.
    unsigned char *pData;
    /// Size of data buffer in bytes.
    unsigned short blockSize;
    /// Number of blocks to be transfered
    unsigned short nbBlock;
    /// Indicate if continue to transfer data
    unsigned char conTrans;
    /// Indicates if the command is a read operation.
    unsigned char isRead;
    /// Response buffer.
    unsigned int  *pResp;
    /// Size of SD card response in bytes.
    unsigned char  resType;
    /// Optional user-provided callback function.
    SdSpiCallback callback;
    /// Optional argument to the callback function.
    void *pArg;

} SdSpiCmd;

/// Above should be put into SD card header file.

//------------------------------------------------------------------------------
/// SPI driver structure. Holds the internal state of the SPI driver and
/// prevents parallel access to a SPI peripheral.
//------------------------------------------------------------------------------
typedef struct {

    /// Pointer to a SPI peripheral.
    AT91S_SPI *pSpiHw;
    /// Pointer to currently executing command.
    SdSpiCmd *pCommand;
    /// Default max timeout (calculated from TAAC & NSAC)
    ///unsigned int  max;
    /// SPI peripheral identifier.
    unsigned char spiId;
    /// Mutex.
    volatile char semaphore;

} SdSpi;

extern void SDSPI_Configure(SdSpi *pSdSpi,AT91PS_SPI pSpiHw,unsigned char spiId);

extern void SDSPI_SetSpeed(SdSpi *pSdSpi, unsigned int spiSpeed);

extern unsigned char SDSPI_SendCommand(SdSpi *pSdSpi, SdSpiCmd *pSdSpiCmd);

extern void SDSPI_Handler(SdSpi *pSdSpi);

extern unsigned char SDSPI_IsTxComplete(SdSpiCmd *pSdSpiCmd);

extern unsigned char SDSPI_IsBusy(SdSpi *pSdSpi);

extern unsigned char SDSPI_NCS(SdSpi *pSdSpi);

extern void SDSPI_Close(SdSpi *pSdSpi);

extern void SDSPI_ConfigureCS(SdSpi *pSdSpi, unsigned char cs, unsigned int csr);

extern unsigned char  SDSPI_StopTranToken(SdSpi *pSdSpi);

extern unsigned char SDSPI_Wait(SdSpi *pSdSpi, unsigned int cycles);

extern unsigned char SDSPI_WaitDataBusy(SdSpi *pSdSpi);

#endif

personal git repositories of Harald Welte. Your mileage may vary