SDIO 30.2 KB
Newer Older
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
;
; Copyright (c) 2012, RISC OS Open Ltd
; 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 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 RISC OS Open Ltd 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 HOLDER 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.
;

        EXPORT  SDIO_InitDevices
        IMPORT  memcpy
        IMPORT  HAL_CounterDelay
        IMPORT  HAL_CounterRead

        ; KEEP ; for debugging

        GET     Hdr:ListOpts
Jeffrey Lee's avatar
Jeffrey Lee committed
37
        GET     Hdr:CPU.Arch
38
        GET     Hdr:Macros
39
        GET     hdr.CastleMacros
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
        GET     hdr.BCM2835
        GET     hdr.StaticWS

sb      RN      9

; Timings

; How long to wait during GPIO pullup/down register procedure
; This is documented as "150 cycles" but not what these are cycles of!
PUD_DELAY       *       150 ; in us - wild guess

; How long to wait for SDCLK to stabilise, in ms
CLOCKSET_TIMEOUT *      20 ; in ms

; Number of SDCLK cycles that must elapse between writes to registers (chip bug)
REGISTER_WRITE_PACE *   2

; Minimum value SDCLK will be set to, in kHz. Is used to set a safe gap between
; writes while reprogramming SDCLK
MIN_SDCLK       *       400

; Base address of controller as an offset from PeriBase
EMMC_Base       *       &00300000

; GPIO pin assignments
Ben Avison's avatar
Ben Avison committed
65 66 67 68 69 70 71 72 73
GPIO_DAT3               *       53
GPIO_DAT2               *       52
GPIO_DAT1               *       51
GPIO_DAT0               *       50
GPIO_CMD                *       49  ; needs pull-up iff in ID mode
GPIO_CLK                *       48
GPIO_CD_AB              *       47  ; needs pull-up; active low
GPIO_STATUS_LED_AB      *       16  ; active low
GPIO_STATUS_LED_BPlus   *       47  ; active high
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

; GPIO function select bitfields
GPIO_FSEL_INPUT  *      0
GPIO_FSEL_OUTPUT *      1
GPIO_FSEL_ALT0   *      2
GPIO_FSEL_ALT1   *      3
GPIO_FSEL_ALT2   *      4
GPIO_FSEL_ALT3   *      5
GPIO_FSEL_ALT4   *      6
GPIO_FSEL_ALT5   *      7
GPIO_FSEL_SHIFT  *      3
GPIO_FSEL_MASK   *      7

; GPIO pull-up/down states
GPIO_PUD_OFF     *      0
GPIO_PUD_DOWN    *      1
GPIO_PUD_UP      *      2

; Selected SD controller registers and bits
Ben Avison's avatar
Ben Avison committed
93 94 95 96 97
ARG1                    *       &08
CMDTM                   *       &0C
CMDTM_CMD_INDEX_SHIFT       *   24
STATUS                  *       &24
STATUS_CMD_INHIBIT          *   1 :SHL: 0
98 99 100 101 102 103 104 105 106
CONTROL1                *       &2C
CONTROL1_CLK_FREQ8_SHIFT    *   8
CONTROL1_CLK_FREQ8_MASK     *   &FF :SHL: CONTROL1_CLK_FREQ8_SHIFT
CONTROL1_CLK_FREQ_MS2_SHIFT *   6
CONTROL1_CLK_FREQ_MS2_MASK  *   3 :SHL: CONTROL1_CLK_FREQ_MS2_SHIFT
CONTROL1_CLK_GENSEL         *   1 :SHL: 5
CONTROL1_CLK_EN             *   1 :SHL: 2
CONTROL1_CLK_STABLE         *   1 :SHL: 1
CONTROL1_CLK_INTLEN         *   1 :SHL: 0
Ben Avison's avatar
Ben Avison committed
107 108 109
INTERRUPT               *       &30
IRPT_MASK               *       &34
IRQ_CC                      *   1 :SHL: 0
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127

; Capabilities bits
CAP_DDR50S      *       1 :SHL: 34
CAP_SDR104S     *       1 :SHL: 33
CAP_SDR50S      *       1 :SHL: 32
CAP_VS18        *       1 :SHL: 26  ; Voltage support 1.8V
CAP_VS30        *       1 :SHL: 25  ; Voltage support 3.0V
CAP_VS33        *       1 :SHL: 24  ; Voltage support 3.3V
CAP_HSS         *       1 :SHL: 21  ; High speed (52MHz) support
CAP_MBL_SHIFT   *       16
CAP_MBL_512     *       0 :SHL: CAP_MBL_SHIFT  ; 512-byte blocks
CAP_MBL_1024    *       1 :SHL: CAP_MBL_SHIFT  ; 1024-byte blocks
CAP_MBL_2048    *       2 :SHL: CAP_MBL_SHIFT  ; 2048-byte blocks
CAP_MBL_MASK    *       3 :SHL: CAP_MBL_SHIFT


        AREA    |Asm$$Code|, CODE, READONLY, PIC

Ben Avison's avatar
Ben Avison committed
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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
; Delay in microseconds between writes to SDHCI registers during speed
; measurement. At this point we don't know what the delay actually needs to be
; because we haven't figured out the clock speed yet, but assuming the GPU boot
; code never sets it slower than 25 MHz, this should be long enough for all cases.
MEASURE_DELAY * 5

; Delay to use when waiting for SDCLK to settle. 20 ms is the longest it's
; supposed to take, and because this is a simplified implementation, we always
; wait this long.
MEASURE_LONG_DELAY * 20000

; If the input clock is 25 MHz, this will set SDCLK to approximately 400 kHz,
; and proportionately higher for other inputs.
MEASURE_DIVIDER * 63

; Command to time is CMD7_SELECT_DESELECT_CARD
MEASURE_COMMAND * 7

; Empirically, I have determined that it takes the controller this many cycles
; of SDCLK to complete a deselect card command
MEASURE_SDCLKS * 56

; Round the estimate of the input clock to nearest multiple of this many MHz
MEASURE_ACCURACY * 5

; Routine to estimate the input clock speed to the SDHCI block based upon how
; long it takes to issue a deselect-all-cards command. This command has no
; response, so it doesn't matter that lots of things aren't set up properly yet.
MeasureSpeed ROUT
        Push    "v1-v3,lr"
        LDR     v1, PeriBase
        ADD     v1, v1, #EMMC_Base

        ; Switch the clock divider to a known value.
        ; This is a simplified version of the algorithm in SetSDCLK.
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay
        LDR     v2, [v1, #CONTROL1]
        BIC     v2, v2, #CONTROL1_CLK_EN ; stop clock going to card
        STR     v2, [v1, #CONTROL1]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay
        BIC     v2, v2, #CONTROL1_CLK_INTLEN ; stop clock
        STR     v2, [v1, #CONTROL1]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay
        BIC     v2, v2, #CONTROL1_CLK_FREQ8_MASK
        BIC     v2, v2, #CONTROL1_CLK_FREQ_MS2_MASK
        ORR     v2, v2, #MEASURE_DIVIDER :SHL: CONTROL1_CLK_FREQ8_SHIFT
        STR     v2, [v1, #CONTROL1]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay
        ORR     v2, v2, #CONTROL1_CLK_INTLEN ; start clock
        STR     v2, [v1, #CONTROL1]
        LDR     a1, =MEASURE_LONG_DELAY
        BL      HAL_CounterDelay
        LDR     v2, [v1, #CONTROL1]
        ORR     v2, v2, #CONTROL1_CLK_EN ; let clock go to card
        STR     v2, [v1, #CONTROL1]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay

        ; Wait for command inhibit to be unset
        ; It's really important that this works, we won't be able to boot if
        ; this never happens, so don't bother with a timeout.
01      LDR     v2, [v1, #STATUS]
        TST     v2, #STATUS_CMD_INHIBIT
        BNE     %B01

        ; Ensure no interrupts are pending
        MOV     lr, #-1
        STR     lr, [v1, #INTERRUPT]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay

        ; Enable the command-complete "interrupt" status bit.
        LDR     v2, =IRQ_CC
        STR     v2, [v1, #IRPT_MASK]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay

        ; Use argument 0 to deselect all cards
        MOV     v2, #0
        STR     v2, [v1, #ARG1]
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay

        ; Wait for the timer to wrap, so we don't have to deal with wrap later
        BL      HAL_CounterRead
02      MOV     v2, a1
        BL      HAL_CounterRead
        CMP     a1, v2
        BLS     %B02

        MRS     v3, CPSR
        ORR     lr, v3, #&80
        MSR     CPSR_c, lr ; IRQs off

        ; Read start time
        BL      HAL_CounterRead
        MOV     v2, a1

        ; Trigger the command (all the other bits in CMDTM are 0)
        MOV     lr, #MEASURE_COMMAND :SHL: CMDTM_CMD_INDEX_SHIFT
        STR     lr, [v1, #CMDTM]

        ; Wait for completion
03      LDR     lr, [v1, #INTERRUPT]
        TST     lr, #IRQ_CC
        BEQ     %B03

        ; Read finish time
        BL      HAL_CounterRead

        ; Acknowledge interrupt
        MOV     lr, #IRQ_CC
        STR     lr, [v1, #INTERRUPT]

        MSR     CPSR_c, v3 ; IRQs restored

        ; Calculate elapsed time
        SUB     v2, v2, a1
        LDR     a1, =MEASURE_DELAY
        BL      HAL_CounterDelay

        ; Calculate input clock frequency
        LDR     a1, =(MEASURE_SDCLKS * MEASURE_DIVIDER) / MEASURE_ACCURACY
        ADD     a1, a1, v2, LSR #1 ; round to nearest
        DivRem  a2, a1, v2, lr
        LDR     a3, =MEASURE_ACCURACY  * 1000
        MUL     a4, a2, a3
        STR     a4, SDHCIInputClock

        Pull    "v1-v3,pc"


264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
        MACRO
$class  HALDeviceField $field, $value
        LCLS    myvalue
      [ "$value" = ""
myvalue SETS    "$field"
      |
myvalue SETS    "$value"
      ]
        ASSERT  . - %A0 = HALDevice_$class$field
     [ ?HALDevice_$class$field = 2
        DCW     $myvalue
   ELIF ?HALDevice_$class$field = 4
        DCD     $myvalue
      |
        %       ?HALDevice_$class$field
      ]
        MEND

; Template for device block

Template
0
        HALDeviceField Type,               HALDeviceType_ExpCtl + HALDeviceExpCtl_SDIO
        HALDeviceField ID,                 HALDeviceID_SDIO_SDHCI
        HALDeviceField Location,           HALDeviceBus_Sys + HALDeviceSysBus_AHB ; judging from the name of the unobtainable Arasan spec!
        HALDeviceField Version,            0
        HALDeviceField Description
        HALDeviceField Address,            0 ; patched up at initialisation
        HALDeviceField Reserved1,          0
Ben Avison's avatar
Ben Avison committed
293
        HALDeviceField Activate,           0 ; patched up at initialisation
294 295 296 297 298 299 300 301 302 303 304
        HALDeviceField Deactivate
        HALDeviceField Reset
        HALDeviceField Sleep
        HALDeviceField Device,             iDev_GPU_SDIO ; unconfirmed
        HALDeviceField TestIRQ
        HALDeviceField ClearIRQ,           0
        HALDeviceField Reserved2,          0
SDHCI   HALDeviceField Flags,              HALDeviceSDHCI_Flag_32bit
SDHCI   HALDeviceField Slots,              1
SDHCI   HALDeviceField SlotInfo,           0 ; patched up at initialisation
SDHCI   HALDeviceField WriteRegister
305
SDHCI   HALDeviceField GetCapabilities,    0 ; patched up at initialisation
306 307
SDHCI   HALDeviceField GetVddCapabilities, 0 ; our fake capabilities register suffices already
SDHCI   HALDeviceField SetVdd
Ben Avison's avatar
Ben Avison committed
308
SDHCI   HALDeviceField SetBusMode,         0
309 310 311 312 313
SDHCI   HALDeviceField PostPowerOn,        0
SDHCI   HALDeviceField SetBusWidth,        0
SDHCI   HALDeviceField GetMaxCurrent
SDHCI   HALDeviceField SetSDCLK
SDHCI   HALDeviceField GetTMCLK
Ben Avison's avatar
Ben Avison committed
314 315
SDHCI   HALDeviceField SetActivity,        0 ; patched up at initialisation
SDHCI   HALDeviceField GetCardDetect,      0 ; patched up at initialisation
316 317 318 319 320 321
SDHCI   HALDeviceField GetWriteProtect


        ; Init the SDHCI HAL device
SDIO_InitDevices ROUT
        Push    "lr"
Ben Avison's avatar
Ben Avison committed
322 323 324 325 326 327 328 329 330 331 332

        CPUDetect a1
        BLS     %FT00
        ; Pi 4 setup - select legacy emmc controller for now
        LDR     a1, PeriBase
        MOV     a2, #3
        ADD     a1, a1, #GPIO_Base
        DoMemBarrier lr
        STR     a2, [a1, #GPPinMuxSD]
        DoMemBarrier lr
00
Ben Avison's avatar
Ben Avison committed
333 334
        BL      MeasureSpeed

335 336 337 338 339
        ADR     a1, SDHCIDevice
        ADR     a2, Template
        MOV     a3, #HALDevice_SDHCISize
        BL      memcpy

Ben Avison's avatar
Ben Avison committed
340
        LDR     a3, Board_Revision
ROOL's avatar
ROOL committed
341
        BIC     a3, a3, #BoardRevision_User_Mask ; mask off overclocking / user bits
342 343
        TST     a3, #BoardRevision_NewScheme
        BNE     %FT01
Jeffrey Lee's avatar
Jeffrey Lee committed
344 345 346 347
        ASSERT  BoardRevision_AorB_Last < BoardRevision_BPlus_Sony
        CMP     a3, #BoardRevision_BPlus_Sony
        TEQ     a3, #BoardRevision_Compute_Sony
        TEQNE   a3, #BoardRevision_Compute_Embest
348 349
        B       %FT02
01      AND     a3, a3, #BoardRevision_Model_Mask
350 351
        ASSERT  BoardRevision_Model_A < BoardRevision_Model_APlus
        ASSERT  BoardRevision_Model_B < BoardRevision_Model_APlus
352 353
        CMP     a3, #BoardRevision_Model_APlus
        TEQ     a3, #BoardRevision_Model_Compute
354 355
        TEQNE   a3, #BoardRevision_Model_Compute3
02      ; So now LO => model A or B, EQ => Compute or Compute3, HI => A+, B+ or Pi 2 or Pi 3 or Pi 0
Ben Avison's avatar
Ben Avison committed
356 357

        ; Activate
358
        ADRLO   a1, Activate_AB
359 360
        ADRHI   a1, Activate_BPlus
        ADREQ   a1, Activate_Compute
Ben Avison's avatar
Ben Avison committed
361 362
        STR     a1, SDHCIDevice + HALDevice_Activate

363 364 365 366 367 368 369
        ; Address and SlotInfo_StdRegs
        LDR     a1, PeriBase
        ADD     a1, a1, #EMMC_Base
        STR     a1, SDHCIDevice + HALDevice_Address
        STR     a1, SDHCISlotInfo + HALDeviceSDHCI_SlotInfo_StdRegs

        ; SlotInfo
370
        ADRL    a1, SDHCISlotInfo
371 372 373 374
        STR     a1, SDHCIDevice + HALDevice_SDHCISlotInfo

        ; SlotInfo_Flags
        MOV     a1, #HALDeviceSDHCI_SlotFlag_Bus4Bit
375 376
        ORRHI   a1, a1, #HALDeviceSDHCI_SlotFlag_NoCardDetect
        ORREQ   a1, a1, #HALDeviceSDHCI_SlotFlag_IntegratedMem
377 378 379 380 381 382 383 384 385 386 387
        BNE     %FT20
        TEQ     a3, #BoardRevision_Model_Compute3
        BNE     %FT10
        LDR     a4, SafetyCatch ; Here iff a Compute Module 3
                                ; Unhelpfully the revision number for both CM3 and CM3L is the same, but we need
                                ; to be sure whether the SDIO attached memory is fixed or removable.
        TEQ     a4, #0
        BICNE   a1, a1, #HALDeviceSDHCI_SlotFlag_IntegratedMem
10
        MOVS    a4, #0 ; put back EQ status
20
388 389
        STR     a1, SDHCISlotInfo + HALDeviceSDHCI_SlotInfo_Flags

390 391
        ; GetCapabilities
        ADR     a1, GetCapabilities_AB_BPlus
392
        ADDEQ   a1, a1, #GetCapabilities_Compute - GetCapabilities_AB_BPlus
393 394
        STR     a1, SDHCIDevice + HALDevice_SDHCIGetCapabilities

Ben Avison's avatar
Ben Avison committed
395 396
        ; SetActivity and GetCardDetect
        ADRL    a1, SetActivity_AB
397 398
        ADDHI   a1, a1, #SetActivity_BPlus - SetActivity_AB
        ADDEQ   a1, a1, #SetActivity_Compute - SetActivity_AB
Ben Avison's avatar
Ben Avison committed
399
        ADRL    a2, GetCardDetect_AB
400
        ADDHS   a2, a2, #GetCardDetect_BPlus_Compute - GetCardDetect_AB
401
        TEQ     a3, #BoardRevision_Model_B3
Jeffrey Lee's avatar
Jeffrey Lee committed
402
        TEQNE   a3, #BoardRevision_Model_B3Plus
Robert Sprowson's avatar
Robert Sprowson committed
403
        TEQNE   a3, #BoardRevision_Model_A3Plus
404
        ADREQL  a1, SetActivity_B3
Ben Avison's avatar
Ben Avison committed
405 406 407
        STR     a1, SDHCIDevice + HALDevice_SDHCISetActivity
        STR     a2, SDHCIDevice + HALDevice_SDHCIGetCardDetect

408 409 410
        MOV     a1, #0 ; flags
        ADR     a2, SDHCIDevice
        Pull    "lr"
411
        CallOS  OS_AddDevice, tailcall
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507

        ; a1 = GPIO pin
        ; a2 = function select number
PinMux_SetFunction ROUT
        Push    "lr"
        MOV     ip, #32 / GPIO_FSEL_SHIFT
        DivRem  a3, a1, ip, lr ; a3 = register, a1 = field in register
        ASSERT  GPIO_FSEL_SHIFT = 3
        ADD     a1, a1, a1, LSL #1

        LDR     a4, PeriBase
        ADD     a4, a4, #GPIO_Base
        ADD     a4, a4, #GPFSel0
        MOV     ip, #GPIO_FSEL_MASK
        MOV     ip, ip, LSL a1
        LDR     lr, [a4, a3, LSL #2]
        BIC     lr, lr, ip
        ORR     lr, lr, a2, LSL a1
        STR     lr, [a4, a3, LSL #2]
        Pull    "pc"

        ; a1 = GPIO pin
        ; a2 = pull type
GPIO_SetPull ROUT
        Push    "v1,lr"
        MOV     v1, a1
        LDR     ip, PeriBase
        ADD     ip, ip, #GPIO_Base
        STR     a2, [ip, #GPPUPDEN]

        MOV     a1, #PUD_DELAY
        BL      HAL_CounterDelay

        LDR     ip, PeriBase
        MOV     lr, #1
        ADD     ip, ip, #GPIO_Base
        ADD     ip, ip, #GPPUDCK0
        AND     a1, v1, #&1F
        MOV     a2, v1, LSR #5
        MOV     lr, lr, LSL a1
        STR     lr, [ip, a2, LSL #2]

        MOV     a1, #PUD_DELAY
        BL      HAL_CounterDelay

        LDR     ip, PeriBase
        MOV     a1, #0
        ADD     ip, ip, #GPIO_Base
        ADD     ip, ip, #GPPUDCK0
        MOV     a2, v1, LSR #5

        ; Manual recommends unsetting registers in this order, but I'm paranoid about an interrupt going off in between
        MRS     lr, CPSR
        ORR     v1, lr, #&C0 ; I and F bits
        MSR     CPSR_c, v1
        STR     a1, [ip, #GPPUPDEN - GPPUDCK0]
        STR     a1, [ip, a2, LSL #2]
        MSR     CPSR_c, lr

        Pull    "v1,pc"

        ; a1 = GPIO pin
        ; a2 = value to set (0 or 1)
GPIO_Output ROUT
        LDR     ip, PeriBase
        TEQ     a2, #0
        ADD     ip, ip, #GPIO_Base
        ADDEQ   ip, ip, #GPClr0
        ADDNE   ip, ip, #GPSet0
        MOV     a4, #1
        MOV     a2, a1, LSR #5
        AND     a1, a1, #&1F
        MOV     a4, a4, LSL a1
        STR     a4, [ip, a2, LSL #2]
        MOV     pc, lr

        ; a1 = GPIO pin
        ; on exit, a1 = 0 or 1
GPIO_Input ROUT
        LDR     ip, PeriBase
        MOV     a4, #1
        MOV     a2, a1, LSR #5
        AND     a1, a1, #&1F
        ADD     ip, ip, #GPIO_Base
        ADD     ip, ip, #GPLev0
        LDR     a3, [ip, a2, LSL #2]
        AND     a1, a4, a3, LSR a1
        MOV     pc, lr

Description DATA
        =       "Arasan SD host controller", 0
        ALIGN

NOPEntry ROUT
        MOV     pc, lr

Ben Avison's avatar
Ben Avison committed
508
Activate_AB ROUT
509 510 511 512 513 514 515 516 517 518 519 520 521 522
        Push    "sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice

        MOV     lr, #0
        STR     lr, SDHCILastWriteCount

        ; SDCLK has to be set up before any register writes are done - it's not
        ; reasonable to expect SDIODriver to know this requirement
        MOV     a3, #MIN_SDCLK
        BL      SetSDCLK

        DoMemBarrier a1 ; switch to GPIO peripheral

        ; Set up pin mux registers and GPIO directions
Ben Avison's avatar
Ben Avison committed
523
        MOV     a1, #GPIO_CD_AB
524 525
        MOV     a2, #GPIO_FSEL_INPUT
        BL      PinMux_SetFunction
Ben Avison's avatar
Ben Avison committed
526
        MOV     a1, #GPIO_CD_AB
527 528
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull
Ben Avison's avatar
Ben Avison committed
529
        MOV     a1, #GPIO_STATUS_LED_AB
530 531
        MOV     a2, #GPIO_FSEL_OUTPUT
        BL      PinMux_SetFunction
Ben Avison's avatar
Ben Avison committed
532
        MOV     a1, #GPIO_STATUS_LED_AB
533 534
        MOV     a2, #GPIO_PUD_OFF
        BL      GPIO_SetPull
Ben Avison's avatar
Ben Avison committed
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
        B       Activate_Common

Activate_BPlus ROUT
        Push    "sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice

        MOV     lr, #0
        STR     lr, SDHCILastWriteCount

        ; SDCLK has to be set up before any register writes are done - it's not
        ; reasonable to expect SDIODriver to know this requirement
        MOV     a3, #MIN_SDCLK
        BL      SetSDCLK

        DoMemBarrier a1 ; switch to GPIO peripheral
550

Ben Avison's avatar
Ben Avison committed
551 552 553 554 555 556 557
        ; Set up pin mux registers and GPIO directions
        MOV     a1, #GPIO_STATUS_LED_BPlus
        MOV     a2, #GPIO_FSEL_OUTPUT
        BL      PinMux_SetFunction
        MOV     a1, #GPIO_STATUS_LED_BPlus
        MOV     a2, #GPIO_PUD_OFF
        BL      GPIO_SetPull
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
        B       Activate_Common

Activate_Compute ROUT
        Push    "sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice

        MOV     lr, #0
        STR     lr, SDHCILastWriteCount

        ; SDCLK has to be set up before any register writes are done - it's not
        ; reasonable to expect SDIODriver to know this requirement
        MOV     a3, #MIN_SDCLK
        BL      SetSDCLK

        DoMemBarrier a1 ; switch to GPIO peripheral
Ben Avison's avatar
Ben Avison committed
573 574
        ; drop through...
Activate_Common
Ben Avison's avatar
Ben Avison committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
        MOV     a1, #GPIO_DAT3
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull
        MOV     a1, #GPIO_DAT2
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull
        MOV     a1, #GPIO_DAT1
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull
        MOV     a1, #GPIO_DAT0
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull
        MOV     a1, #GPIO_CMD
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull
        MOV     a1, #GPIO_CLK
        MOV     a2, #GPIO_PUD_UP
        BL      GPIO_SetPull

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
        DoMemBarrier a1 ; back to SDHCI peripheral

        MOV     a1, #1 ; always succeed
        Pull    "sb,pc"

Deactivate * NOPEntry

Reset * NOPEntry ; I don't think there's any way for us to reset the controller

Sleep ROUT
        MOV     a1, #0
        MOV     pc, lr

TestIRQ ROUT
        ; Not a shared interrupt, so it must be our fault
        MOV     a1, #1
        MOV     pc, lr

WriteRegister ROUT
        ; The BCM2835 has a bug which means that we have to leave 2 SDCLK cycles
        ; between each SDHCI register write, except for those to the data port.
        ; This entry point isn't used for data port writes, so there is no need
        ; to filter them out.
        Push    "v1-v4,sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice
        MOV     v3, a3
        MOV     v4, a4

        BL      HAL_CounterRead
        LDR     v1, SDHCILastWriteCount ; v1 = upper limit of pause period
        LDR     v2, SDHCIWriteInterval
        SUBS    v2, v1, v2              ; v2 = lower limit of pause period
        BPL     %F30

        ; The precise value of the counter frequency is liable to change over
        ; time to correct for clock drift, so if our delay includes the wrap
        ; point then we have to be careful to avoid proportionately large errors.
        ; The approach we take is to wait until a wrap happens, then do an
        ; additional wait for the remainder of the time, starting from the count
        ; we read back from the hardware.
        B       %F20
10      BL      HAL_CounterRead
20      CMP     a1, v1
        BLS     %B10
        MOV     v1, a1
        ADD     v2, v2, v1

        ; Loop while counter <= upper limit and counter > lower limit
30      ADD     v1, v1, #1
        B       %F50
40      BL      HAL_CounterRead
50      CMP     a1, v1
        CMPLO   v2, a1
        BLO     %B40

        ; Now we can do the register write
        STR     v4, [v3]

        ; Remember the time at which we did the write
        BL      HAL_CounterRead
        STR     a1, SDHCILastWriteCount
        Pull    "v1-v4,sb,pc"

657
GetCapabilities_AB_BPlus ROUT
658 659 660
        ; Vss is fixed in hardware - see schematics
        ; Eben says high bus speed doesn't work, but Linux seems to manage?
        ; Buffer size is mentioned in the prose in the BCM2835 ARM peripherals datasheet
Ben Avison's avatar
Ben Avison committed
661
        LDR     a1, =CAP_VS33 :OR: CAP_HSS :OR: CAP_MBL_1024
662 663
        MOV     pc, lr

664 665 666 667 668 669 670 671 672 673 674
GetCapabilities_Compute ROUT
        ; The eMMC chip doesn't seem to be compatible with the BCM2835's high bus speed timings.
        ; We get command line conflicts unless we set HostControl1's HSE bit (which we don't
        ; normally do due to compatibility issues with some 50 MHz MMCplus cards and 52 MHz
        ; SD cards, which otherwise function on the Pis with card slots - see SDIODriver.c.probe
        ; for more). But even if we do set HSE, data transfer is too unreliable for practical
        ; use with the eMMC. The easiest workaround is to alter the fake capabilities register
        ; to claim that high speed isn't supported by the controller.
        LDR     a1, =CAP_VS33 :OR: CAP_MBL_1024
        MOV     pc, lr

675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
SetVdd * NOPEntry ; There is no software control of Vdd for this board

GetMaxCurrent ROUT
        ; Can't find any information on this, so just stick with a low value
        MOV     a1, #100
        MOV     pc, lr

        ; In: a1 = requested frequency, kHz
        ; Out: v1 = how many counter ticks we have to see to guarantee 2 SDCLK cycles have passed
        ;      v2 = divider to use
        ;      v3 = actual frequency achieved, kHz
        ;      a2,a4,ip corrupted
CalcTimings ROUT
        ; By experimentation, I've determined that the 40 MHz input clock
        ; can be divided by any integer from 1 to 1023.
Ben Avison's avatar
Ben Avison committed
690
        LDR     ip, SDHCIInputClock
691
        ADD     ip, ip, a1 ; input clock, adjusted to ensure round up
Ben Avison's avatar
Ben Avison committed
692
        SUB     ip, ip, #1
693 694 695 696 697 698 699 700 701
        DivRem  v2, ip, a1, a2
        CMP     v2, #1
        MOVLO   v2, #1
        MOV     ip, #1024
        CMP     v2, #1024
        SUBHS   v2, ip, #1

        ; v2 now contains the final divisor. Work out what frequency that
        ; corresponds to.
Ben Avison's avatar
Ben Avison committed
702
        LDR     ip, SDHCIInputClock
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
        DivRem  v3, ip, v2, a2

        ; Work out how many counter ticks we have to see to guarantee 2 SDCLK cycles
        ; between each register write. This is 2 * (counter-freq / SDCLK-freq)
        ; with a round up, or (2 * counter-freq + SDCLK-freq - 1) / SDCLK-freq
        ; Also add 1 to allow for the fact that when the first count is read, we
        ; don't know how close to the end of that counter period it is.
        MOV     ip, #1000
        MUL     a4, v3, ip
        LDR     ip, =REGISTER_WRITE_PACE * TIMER_RATE - 1
        ADD     ip, ip, a4
        DivRem  v1, ip, a4, a2
        ADD     v1, v1, #1
        MOV     pc, lr

SetSDCLK ROUT
        Push    "v1-v5,sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice

        ; Set a long gap between writes while we're fiddling with the SDCLK
        MOV     a1, #MIN_SDCLK
        BL      CalcTimings
        STR     a1, SDHCIWriteInterval

        ; Calculate desired values
        MOV     a1, a3
        BL      CalcTimings
        ; v1 = interval, v2 = divider, v3 = freq

        ; Program clock control register
        LDR     v5, PeriBase
        ADD     v5, v5, #EMMC_Base
        LDR     v4, [v5, #CONTROL1]!

        BIC     v4, v4, #CONTROL1_CLK_EN ; stop clock going to card
        ADR     a1, SDHCIDevice
        MOV     a3, v5
        MOV     a4, v4
        BL      WriteRegister

        BIC     v4, v4, #CONTROL1_CLK_INTLEN ; stop clock
        ADR     a1, SDHCIDevice
        MOV     a3, v5
        MOV     a4, v4
        BL      WriteRegister

        BIC     v4, v4, #CONTROL1_CLK_FREQ8_MASK
        BIC     v4, v4, #CONTROL1_CLK_FREQ_MS2_MASK
        MOV     a1, v2, LSL #CONTROL1_CLK_FREQ8_SHIFT - 0
        MOV     a2, v2, LSR #8 - CONTROL1_CLK_FREQ_MS2_SHIFT
        AND     a1, a1, #CONTROL1_CLK_FREQ8_MASK
        AND     a2, a2, #CONTROL1_CLK_FREQ_MS2_MASK
        ORR     v4, v4, a1
        ORR     v4, v4, a2
        ADR     a1, SDHCIDevice
        MOV     a3, v5
        MOV     a4, v4
        BL      WriteRegister

        ORR     v4, v4, #CONTROL1_CLK_INTLEN ; start clock
        ADR     a1, SDHCIDevice
        MOV     a3, v5
        MOV     a4, v4
        BL      WriteRegister

        ; Wait for up to 20 ms for the clock to stabilise
        ; v2 = previous counter value
        ; v4 = time remaining
        BL     HAL_CounterRead
        MOV    v2, a1
        LDR    v4, =(TIMER_RATE * CLOCKSET_TIMEOUT) / 1000
70      LDR    a4, [v5]
        CMP    v4, #0
        BMI    %F80 ; timed out (hope this never happens!)
        TST    a4, #CONTROL1_CLK_STABLE
        BNE    %F80 ; stabilised
        BL     HAL_CounterRead
        SUBS   a2, a1, v2 ; elapsed since last time - if -ve then we have wrap so do nothing
        SUBPL  v4, v4, a2
        MOV    v2, a1
        B      %B70

80      ; Re-enable clock
        ADR     a1, SDHCIDevice
        MOV     a3, v5
        ORR     a4, a4, #CONTROL1_CLK_EN
        BL      WriteRegister

        ; Now we can save the final gap
        STR     v1, SDHCIWriteInterval
        ; Return the actual frequency
        MOV     a1, v3
        Pull    "v1-v5,sb,pc"

GetTMCLK ROUT
        ; SDCLK is reused for TMCLK
        Push    "sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice
        LDR     a1, PeriBase
        ADD     a1, a1, #EMMC_Base
        LDR     a2, [a1, #CONTROL1]
        AND     a3, a2, #CONTROL1_CLK_FREQ8_MASK
        AND     a4, a2, #CONTROL1_CLK_FREQ_MS2_MASK
        MOV     a3, a3, LSR #CONTROL1_CLK_FREQ8_SHIFT - 0
        ORR     a3, a3, a4, LSL #8 - CONTROL1_CLK_FREQ_MS2_SHIFT
Ben Avison's avatar
Ben Avison committed
808
        LDR     a2, SDHCIInputClock
809 810 811
        DivRem  a1, a2, a3, a4
        Pull    "sb,pc"

Ben Avison's avatar
Ben Avison committed
812
SetActivity_AB ROUT
813 814 815 816 817 818 819 820
        Push    "sb,lr"
        DoMemBarrier lr ; switch to GPIO peripheral
        SUB     sb, a1, #:INDEX:SDHCIDevice

        ; Line is active low
        TEQ     a3, #HALDeviceSDHCI_ActivityOff
        MOVEQ   a2, #1
        MOVNE   a2, #0
Ben Avison's avatar
Ben Avison committed
821
        MOV     a1, #GPIO_STATUS_LED_AB
822 823 824 825 826
        BL      GPIO_Output

        DoMemBarrier lr ; back to SDHCI peripheral
        Pull    "sb,pc"

Ben Avison's avatar
Ben Avison committed
827
SetActivity_BPlus ROUT
828 829 830 831
        Push    "sb,lr"
        DoMemBarrier lr ; switch to GPIO peripheral
        SUB     sb, a1, #:INDEX:SDHCIDevice

Ben Avison's avatar
Ben Avison committed
832 833 834 835 836 837 838 839 840 841
        ; Line is active high
        ASSERT  HALDeviceSDHCI_ActivityOff = 0
        MOVS    a2, a3
        MOVNE   a2, #1
        MOV     a1, #GPIO_STATUS_LED_BPlus
        BL      GPIO_Output

        DoMemBarrier lr ; back to SDHCI peripheral
        Pull    "sb,pc"

842 843 844 845
SetActivity_Compute ROUT
        ; No standard way of wiring up the activity LED on Compute
        MOV     pc, lr

846 847 848 849 850 851 852 853 854 855
SetActivity_B3 ROUT
        Push    "sb,lr"
        SUB     sb, a1, #:INDEX:SDHCIDevice
        LDR     a1, VirtGPIOBuf
        CMP     a1, #0
        Pull    "sb,pc",EQ
        ; The virtual GPIO buffer uses some funny counter system to track enable/disable state changes. If we don't follow its rules, it won't work.
        LDR     a2, [a1]
        SXTH    a4, a2, ROR #16 ; Enable count
        SXTH    a2, a2 ; Disable count
856 857
        SUB     lr, a4, a2
        SXTH    lr, lr ; Difference
858 859
        TEQ     a3, #HALDeviceSDHCI_ActivityOff
        BEQ     %FT50
860
        CMP     lr, #0
861 862 863 864
        Pull    "sb,pc", GT ; Don't update if already on
        ADD     a4, a4, #1
        B       %FT90
50
865
        CMP     lr, #0
866 867 868 869 870 871 872
        Pull    "sb,pc", LE ; Don't update if already off
        ADD     a2, a2, #1
90
        PKHBT   a2, a2, a4, LSL #16
        STR     a2, [a1]
        Pull    "sb,pc"

Ben Avison's avatar
Ben Avison committed
873 874 875 876 877 878
GetCardDetect_AB ROUT
        Push    "sb,lr"
        DoMemBarrier lr ; switch to GPIO peripheral
        SUB     sb, a1, #:INDEX:SDHCIDevice

        MOV     a1, #GPIO_CD_AB
879 880 881 882 883 884 885 886
        BL      GPIO_Input
        ; Line is active low, so invert
        SUB     a1, a1, #1
        AND     a1, a1, #1

        DoMemBarrier lr ; back to SDHCI peripheral
        Pull    "sb,pc"

887
GetCardDetect_BPlus_Compute ROUT
Ben Avison's avatar
Ben Avison committed
888 889 890 891 892
        ; CD is not connected. This entry shouldn't be called, but just in case
        ; (perhaps someone softloaded old SDFSDriver/SDFS?) report card present
        MOV     a1, #1
        MOV     pc, lr

893 894 895 896 897 898
GetWriteProtect ROUT
        ; WP is not connected, so just have to always report unprotected :-(
        MOV     a1, #0
        MOV     pc, lr

        END