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
|
/*******************************************************************************
Copyright (C) 2016 Marvell International Ltd.
Marvell BSD License Option
If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File under the following licensing terms.
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 following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Marvell nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
*******************************************************************************/
#ifndef __SPI_MASTER_H__
#define __SPI_MASTER_H__
#include <Library/IoLib.h>
#include <Library/PcdLib.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Uefi/UefiBaseType.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Protocol/Spi.h>
#define SPI_MASTER_SIGNATURE SIGNATURE_32 ('M', 'S', 'P', 'I')
#define SPI_MASTER_FROM_SPI_MASTER_PROTOCOL(a) CR (a, SPI_MASTER, SpiMasterProtocol, SPI_MASTER_SIGNATURE)
// Marvell Flash Device Controller Registers
#define SPI_CTRL_REG (0x00)
#define SPI_CONF_REG (0x04)
#define SPI_DATA_OUT_REG (0x08)
#define SPI_DATA_IN_REG (0x0c)
#define SPI_INT_CAUSE_REG (0x10)
// Serial Memory Interface Control Register Masks
#define SPI_CS_NUM_OFFSET 2
#define SPI_CS_NUM_MASK (0x7 << SPI_CS_NUM_OFFSET)
#define SPI_MEM_READY_MASK (0x1 << 1)
#define SPI_CS_EN_MASK (0x1 << 0)
// Serial Memory Interface Configuration Register Masks
#define SPI_BYTE_LENGTH_OFFSET 5
#define SPI_BYTE_LENGTH (0x1 << SPI_BYTE_LENGTH_OFFSET)
#define SPI_CPOL_OFFSET 11
#define SPI_CPOL_MASK (0x1 << SPI_CPOL_OFFSET)
#define SPI_CPHA_OFFSET 12
#define SPI_CPHA_MASK (0x1 << SPI_CPHA_OFFSET)
#define SPI_TXLSBF_OFFSET 13
#define SPI_TXLSBF_MASK (0x1 << SPI_TXLSBF_OFFSET)
#define SPI_RXLSBF_OFFSET 14
#define SPI_RXLSBF_MASK (0x1 << SPI_RXLSBF_OFFSET)
#define SPI_SPR_OFFSET 0
#define SPI_SPR_MASK (0xf << SPI_SPR_OFFSET)
#define SPI_SPPR_0_OFFSET 4
#define SPI_SPPR_0_MASK (0x1 << SPI_SPPR_0_OFFSET)
#define SPI_SPPR_HI_OFFSET 6
#define SPI_SPPR_HI_MASK (0x3 << SPI_SPPR_HI_OFFSET)
#define SPI_TRANSFER_BEGIN 0x01 // Assert CS before transfer
#define SPI_TRANSFER_END 0x02 // Deassert CS after transfers
#define SPI_TIMEOUT 100000
typedef struct {
MARVELL_SPI_MASTER_PROTOCOL SpiMasterProtocol;
UINTN Signature;
EFI_HANDLE Handle;
EFI_LOCK Lock;
} SPI_MASTER;
EFI_STATUS
EFIAPI
MvSpiTransfer (
IN MARVELL_SPI_MASTER_PROTOCOL *This,
IN SPI_DEVICE *Slave,
IN UINTN DataByteCount,
IN VOID *DataOut,
IN VOID *DataIn,
IN UINTN Flag
);
EFI_STATUS
EFIAPI
MvSpiReadWrite (
IN MARVELL_SPI_MASTER_PROTOCOL *This,
IN SPI_DEVICE *Slave,
IN UINT8 *Cmd,
IN UINTN CmdSize,
IN UINT8 *DataOut,
OUT UINT8 *DataIn,
IN UINTN DataSize
);
EFI_STATUS
EFIAPI
MvSpiInit (
IN MARVELL_SPI_MASTER_PROTOCOL * This
);
SPI_DEVICE *
EFIAPI
MvSpiSetupSlave (
IN MARVELL_SPI_MASTER_PROTOCOL * This,
IN UINTN Cs,
IN SPI_MODE Mode
);
EFI_STATUS
EFIAPI
MvSpiFreeSlave (
IN SPI_DEVICE *Slave
);
EFI_STATUS
EFIAPI
SpiMasterEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
#endif // __SPI_MASTER_H__
|
