spinand.c 22.4 KB
Newer Older
W
Wayne Lin 已提交
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
/**************************************************************************//**
*
* @copyright (C) 2019 Nuvoton Technology Corp. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*
* Change Logs:
* Date            Author       Notes
* 2021-1-13       Wayne        First version
*
******************************************************************************/

#include <rtthread.h>

#if defined(NU_PKG_USING_SPINAND)

#define LOG_TAG                 "spinand_flash"
#define DBG_ENABLE
#define DBG_SECTION_NAME        LOG_TAG
#define DBG_LEVEL               DBG_INFO
#define DBG_COLOR
#include <rtdbg.h>

#include "spinand.h"

const struct nu_spinand_info g_spinandflash_list[] =
{
    /* Winbond */
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
    /* Only tested */
    {
        0xEFAA21, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 1024, 64, 0, "Winbond 128MB: 2048+64@64@1024",
#if defined(RT_USING_DFS_UFFS)
        {
            /* For storing Seal-byte at 0x37. Need 15-Bytes */
            0x04, 0x04, 0x14, 0x04, 0x24, 0x04, 0x34, 0x03, 0xFF, 0x00
        },
        {
            /* For storing Seal-byte at 0x37 and not report latest ECC part in Spare-3 */
            0x08, 0x08, 0x18, 0x08, 0x28, 0x08, /*0x38, 0x08,*/ 0xFF, 0x00
        }
#else
        {
            0x04, 0x04, 0x14, 0x04, 0x24, 0x04, 0x34, 0x04, 0xFF, 0x00
        },
        {
            0x08, 0x08, 0x18, 0x08, 0x28, 0x08, 0x38, 0x08, 0xFF, 0x00
        }
#endif
    },

    {
        0xEFBF22, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 2048, 64, 0, "Winbond 256MB: 2048+64@64@2048",
#if defined(RT_USING_DFS_UFFS)
        {
            /* For storing Seal-byte at 0x39. Need 15-Bytes */
            0x08, 0x04, 0x18, 0x04, 0x28, 0x04, 0x38, 0x03, 0xFF, 0x00
        },
        {
            /* For storing Seal-byte at 0x39 and not report latest ECC part in Spare-3 */
            0x0C, 0x04, 0x1C, 0x04, 0x2C, 0x04, /*0x3C, 0x04,*/ 0xFF, 0x00
        }
#else
        {
            0x08, 0x04, 0x18, 0x04, 0x28, 0x04, 0x38, 0x04, 0xFF, 0x00
        },
        {
            0x0C, 0x04, 0x1C, 0x04, 0x2C, 0x04, 0x3C, 0x04, 0xFF, 0x00
        }
#endif
    },
W
Wayne Lin 已提交
71

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
    {
        /* Here, we just only define 64B for spare area, not ECC area. */
        0xEFBA23, 2048, 64, 0x6b, 0x05, 0x01, 0x02, 0x1, 4096, 64, 0, "Winbond 512MB: 2048+128@64@4096",
#if defined(RT_USING_DFS_UFFS)
        {
            /* For storing Seal-byte at 0x39. Need 15-Bytes */
            0x04, 0x0C, 0x14, 0x0C, 0x24, 0x0C, 0x34, 0x0B, 0xFF, 0x00
        },
        {
            /* No report latest ECC part in Spare-3 */
            0xFF, 0x00
        }
#else
        {
            0x04, 0x0C, 0x14, 0x0C, 0x24, 0x0C, 0x34, 0x0C, 0xFF, 0x00
        },
        {
            0x40, 0x40, 0xFF, 0x00
        }
#endif
    },

W
Wayne Lin 已提交
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
#if 0
    { 0xEFAA22, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 2048, 64, 0, "Winbond 256MB: 2048+64@64@1024" },
    { 0xEFAB21, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 1024, 64, 1, "Winbond 256MB: 2048+64@64@1024, MCP" },

    /* Not test and supporting yet. */
    /* MXIC */
    { 0x00C212, 2048, 64, 0x6b, 0x05, 0x01, 0x40, 0x1, 1024, 64, 0, "MXIC 128MB: 2048+64@64@1024" },

    /* XTX */
    { 0x0BE20B, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 2048, 64, 0, "XTX 256MB: 2048+64@64@2048" },
    { 0x0BF20B, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 2048, 64, 0, "XTX 256MB: 2048+64@64@2048" },
    { 0x0BE10B, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 1024, 64, 0, "XTX 256MB: 2048+64@64@1024" },
    { 0x0BF10B, 2048, 64, 0x6b, 0xff, 0xff, 0xff, 0x1, 1024, 64, 0, "XTX 256MB: 2048+64@64@1024" },

    /* ATO */
    { 0x9B129B, 2048, 64, 0x6b, 0x0f, 0x1f, 0x01, 0x1, 1024, 64, 0, "ATO 128MB: 2048+64@64@1024" },

    /* Micro */
    { 0x2C242C, 2048, 128, 0x6b, 0x0f, 0x1f, 0x01, 0x1, 2048, 64, 0, "Micro 256MB: 2048+128@64@2048" },

    /* GigaDevice */
    { 0xB148C8, 2048, 128, 0x6b, 0x0f, 0x1f, 0x01, 0x1, 1024, 64, 0, "GD 128MB: 2048+128@64@1024" },

    /* Unknown */
    { 0x00C8D1, 2048, 128, 0x6b, 0x0f, 0x1f, 0x01, 0x1, 1024, 64, 0, "Unknown 128MB: 2048+128@64@1024" },
    { 0x00C851, 2048, 128, 0x6b, 0x0f, 0x1f, 0x01, 0x1, 1024, 64, 0, "Unknown 128MB: 2048+128@64@1024" },
    { 0x98E240, 2048, 128, 0x6b, 0x0f, 0x1f, 0x01, 0x1, 1024, 64, 0, "Unknown 128MB: 2048+128@64@1024" }
#endif
};
#define SPINAND_LIST_ELEMENT_NUM ( sizeof(g_spinandflash_list)/sizeof(struct nu_spinand_info) )

/*
126
========================================================
W
Wayne Lin 已提交
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
For 0xEFAA21 description:

Data Area(2048-Byte)
-----------------------------
|Sect-0|Sect-1|Sect-2|Sect-3|
|(512B)|(512B)|(512B)|(512B)|
-----------------------------

         Spare Area(64-Byte)
         ---------------------------------
         |Spare-0|Spare-1|Spare-2|Spare-3|
         | (16B) | (16B) | (16B) | (16B) |
         ---------------------------------

 ----------------- Spare-0 -------------------
/                                             \
-------------------------------------------------
| BBM | UD2 |   UD1   |  ECC Sect-0 | ECC Spare |
| 0 1 | 2 3 | 4 5 6 7 | 8 9 A B C D | E F       |
-------------------------------------------------
|  NO ECC   |   ECC PROTECTED       |  ECC 4-D  |

BBM: Bad block marker.
UD1: User Data 1.
UD2: User Data 2.
ECC Sect-n: ECC for sector-n.
ECC Spare: ECC for spare 4-D.

 ---------------- Spare-1 -------------------
/                                            \
-----------------------------------------------
|   UD2   |   UD1   |  ECC Sect-1 | ECC Spare |
| 0 1 2 3 | 4 5 6 7 | 8 9 A B C D | E F       |
-----------------------------------------------
|  NO ECC |   ECC PROTECTED       | ECC 14-1D |

 ---------------- Spare-2 -------------------
/                                            \
-----------------------------------------------
|   UD2   |   UD1   |  ECC Sect-2 | ECC Spare |
| 0 1 2 3 | 4 5 6 7 | 8 9 A B C D | E F       |
-----------------------------------------------
|  NO ECC |   ECC PROTECTED       | ECC 24-2D |

 ---------------- Spare-3 -------------------
/                                            \
-----------------------------------------------
|   UD2   |   UD1   |  ECC Sect-3 | ECC Spare |
| 0 1 2 3 | 4 5 6 7 | 8 9 A B C D | E F       |
-----------------------------------------------
|  NO ECC |   ECC PROTECTED       | ECC 34-3D |

179
========================================================
W
Wayne Lin 已提交
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
========================================================
For 0xEFBF22 description:

Data Area(2048-Byte)
-----------------------------
|Sect-0|Sect-1|Sect-2|Sect-3|
|(512B)|(512B)|(512B)|(512B)|
-----------------------------

         Spare Area(64-Byte)
         ---------------------------------
         |Spare-0|Spare-1|Spare-2|Spare-3|
         | (16B) | (16B) | (16B) | (16B) |
         ---------------------------------

 ----------------- Spare-0 -------------------
/                                             \
-----------------------------------------
| BBM |     UD2     |   UD1   | ECC UD1 |
| 0 1 | 2 3 4 5 6 7 | 8 9 A B | C D E F |
-----------------------------------------
|       NO ECC      |   ECC PROTECTED   |

BBM: Bad block marker.
UD1: User Data 1.
UD2: User Data 2.
ECC UD1: ECC for UD1.

 ---------------- Spare-1 -------------------
/                                            \
---------------------------------------
|       UD2       |   UD1   | ECC UD1 |
| 0 1 2 3 4 5 6 7 | 8 9 A B | C D E F |
---------------------------------------
|      NO ECC     |   ECC PROTECTED   |

 ---------------- Spare-2 -------------------
/                                            \
---------------------------------------
|       UD2       |   UD1   | ECC UD1 |
| 0 1 2 3 4 5 6 7 | 8 9 A B | C D E F |
---------------------------------------
|      NO ECC     |   ECC PROTECTED   |

 ---------------- Spare-3 -------------------
/                                            \
---------------------------------------
|       UD2       |   UD1   | ECC UD1 |
| 0 1 2 3 4 5 6 7 | 8 9 A B | C D E F |
---------------------------------------
|      NO ECC     |   ECC PROTECTED   |

========================================================
*/

rt_uint8_t spinand_flash_data_layout[SPINAND_SPARE_LAYOUT_SIZE];
rt_uint8_t spinand_flash_ecc_layout[SPINAND_SPARE_LAYOUT_SIZE];
W
Wayne Lin 已提交
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 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 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 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 657 658 659 660

static rt_err_t spinand_info_read(struct rt_qspi_device *qspi);

static rt_err_t spinand_die_select(struct rt_qspi_device *qspi, uint8_t select_die)
{
    uint8_t au8Cmd[2] = { 0xC2, 0x0 };
    au8Cmd[1] = select_die;

    return nu_qspi_send(qspi, &au8Cmd[0], sizeof(au8Cmd));
}

static uint8_t spinand_isbusy(struct rt_qspi_device *qspi)
{
#define BUSY_CKECKING_TIMEOUT_MS  3000
    volatile uint8_t SR = 0xFF;
    rt_err_t result;
    uint8_t au8Cmd[2] = { 0x0F, 0xC0 };

    uint32_t u32CheckingDuration = rt_tick_from_millisecond(BUSY_CKECKING_TIMEOUT_MS);
    uint32_t u32Start = rt_tick_get();

    do
    {
        result = nu_qspi_send_then_recv(qspi, &au8Cmd[0], sizeof(au8Cmd), (void *)&SR, 1);
        if (result != RT_EOK)
            goto timeout_spinand_isbusy;

        if ((rt_tick_get() - u32Start) >= u32CheckingDuration)
        {
            goto timeout_spinand_isbusy;
        }

    }
    while ((SR & 0x1) != 0x00);

    return 0;

timeout_spinand_isbusy:

    LOG_E("Error: spinand timeout.");

    return 1;
}

static rt_err_t spinand_program_dataload(
    struct rt_qspi_device *qspi,
    uint8_t u8AddrH,
    uint8_t u8AddrL,
    uint8_t *pu8DataBuff,
    uint32_t u32DataCount,
    uint8_t *pu8SpareBuff,
    uint32_t u32SpareCount)
{
    uint8_t u8WECmd = 0x06;
    rt_err_t result = RT_EOK;

    struct rt_qspi_message qspi_messages[2] = {0};

    /* 1-bit mode */
    qspi_messages[0].instruction.content    = 0x32;
    qspi_messages[0].instruction.qspi_lines = 1;

    qspi_messages[0].address.content = (u8AddrH << 8) | (u8AddrL);
    qspi_messages[0].address.size = 2 * 8;
    qspi_messages[0].address.qspi_lines = 1;

    /* 4-bit mode */
    qspi_messages[0].qspi_data_lines   = 4;
    qspi_messages[0].parent.cs_take    = 1;
    qspi_messages[0].parent.cs_release = 0;
    qspi_messages[0].parent.send_buf   = pu8DataBuff;
    qspi_messages[0].parent.length     = u32DataCount;
    qspi_messages[0].parent.next       = &qspi_messages[1].parent;

    qspi_messages[1].qspi_data_lines   = 4;
    qspi_messages[1].parent.cs_take    = 0;
    qspi_messages[1].parent.cs_release = 1;
    qspi_messages[1].parent.send_buf   = pu8SpareBuff;
    qspi_messages[1].parent.length     = u32SpareCount;

    if ((result = nu_qspi_send(qspi, &u8WECmd, sizeof(u8WECmd))) != RT_EOK)
        goto exit_spinand_program_dataload;

    result = nu_qspi_transfer_message(qspi, (struct rt_qspi_message *)&qspi_messages[0]);

exit_spinand_program_dataload:

    return result;
}

static uint8_t spinand_status_register_read(struct rt_qspi_device *qspi, uint8_t u8SRSel)
{
    uint8_t u8SR = 0;
    uint8_t au8Cmd[2];

    switch (u8SRSel)
    {
    case 0x01:
        au8Cmd[0] = 0x05;
        au8Cmd[1] = 0xA0;
        break;

    case 0x02:
        au8Cmd[0] = 0x0F;
        au8Cmd[1] = 0xB0;
        break;

    case 0x03:
        au8Cmd[0] = 0x05;
        au8Cmd[1] = 0xC0;
        break;

    default:
        RT_ASSERT(0);
        break;
    }

    if (nu_qspi_send_then_recv(qspi, &au8Cmd[0], sizeof(au8Cmd), &u8SR, 1) != RT_EOK)
        RT_ASSERT(0);

    return u8SR;
}

static rt_err_t spinand_status_register_write(struct rt_qspi_device *qspi, uint8_t u8SRSel, uint8_t u8Value)
{
    rt_err_t result = RT_EOK;
    uint8_t au8Cmd[3];

    switch (u8SRSel)
    {
    case 0x01:
        au8Cmd[0] = 0x01;
        au8Cmd[1] = 0xA0;
        break;

    case 0x02:
        au8Cmd[0] = 0x01;
        au8Cmd[1] = 0xB0;
        break;

    case 0x03:
        au8Cmd[0] = 0x01;
        au8Cmd[1] = 0xC0;
        break;

    default:
        result = RT_EINVAL;
        goto exit_spinand_status_register_write;
    }

    au8Cmd[2] = u8Value;

    if ((result = nu_qspi_send(qspi, &au8Cmd[0], sizeof(au8Cmd))) != RT_EOK)
        goto exit_spinand_status_register_write;

    if (spinand_isbusy(qspi))
    {
        result = RT_EIO;
        goto exit_spinand_status_register_write;
    }

exit_spinand_status_register_write:

    return result;
}

static rt_err_t spinand_program_execute(struct rt_qspi_device *qspi,  uint8_t u8Addr2, uint8_t u8Addr1, uint8_t u8Addr0)
{
    rt_err_t result;
    uint8_t au8Cmd[4], u8SR;

    au8Cmd[0] = 0x10 ;
    au8Cmd[1] = u8Addr2;
    au8Cmd[2] = u8Addr1;
    au8Cmd[3] = u8Addr0;

    if ((result = nu_qspi_send(qspi, &au8Cmd, sizeof(au8Cmd))) != RT_EOK)
        goto exit_spinand_program_execute;

    if (spinand_isbusy(qspi))
    {
        result = -RT_MTD_EIO;
        goto exit_spinand_program_execute;
    }

    u8SR = (spinand_status_register_read(SPINAND_FLASH_QSPI, 3) & 0x0C) >> 2;
    if (u8SR == 1)
    {
        result = -RT_MTD_EIO;
        LOG_E("Error write status!");
    }

exit_spinand_program_execute:

    return result;
}

static rt_err_t spinand_normal_read(struct rt_qspi_device *qspi, uint8_t u8AddrH, uint8_t u8AddrL, uint8_t *pu8Buff, uint32_t u32Count)
{
    uint8_t au8Cmd[4];

    au8Cmd[0] = 0x03;
    au8Cmd[1] = u8AddrH;
    au8Cmd[2] = u8AddrL;
    au8Cmd[3] = 0x00;

    return nu_qspi_send_then_recv(qspi, &au8Cmd[0], sizeof(au8Cmd), pu8Buff, u32Count);
}

static rt_err_t spinand_protect_set(struct rt_qspi_device *qspi, uint8_t u8Protect)
{
    /* Read status register 1 */
    uint8_t u8SR = spinand_status_register_read(qspi, 1);

    if (u8Protect)
    {
        /* protect */
        u8SR |= 0x7C;
    }
    else
    {
        /* unprotect */
        u8SR &= 0x83;
    }

    return spinand_status_register_write(qspi, 1, u8SR);
}

static uint8_t spinand_program_erase_isfail(struct rt_qspi_device *qspi)
{
    /* Read status register 3 */
    uint8_t u8SR = spinand_status_register_read(qspi, 3);
    return (u8SR & 0x0C) >> 2; /* Check P-Fail, E-Fail bit */
}

static uint8_t spinand_hwecc_status_get(struct rt_qspi_device *qspi)
{
    /* Read status register 3 */
    uint8_t u8SR = spinand_status_register_read(qspi, 3);
    return (u8SR & 0x30) >> 4; /* ECC-1, ECC0 bit */
}

static rt_err_t spinand_hwecc_set(struct rt_qspi_device *qspi, uint8_t u8Enable)
{
    uint8_t u8SR = spinand_status_register_read(qspi, 2); // Read status register 2

    if (u8Enable)
    {
        u8SR |= 0x10; // Enable ECC-E bit
    }
    else
    {
        u8SR &= 0xEF; // Disable ECC-E bit
    }

    return spinand_status_register_write(qspi, 2, u8SR);
}

static uint8_t spinand_hwecc_get(struct rt_qspi_device *qspi)
{
    /* Read status register 2 */
    uint8_t u8SR = spinand_status_register_read(qspi, 2);
    return (u8SR & 0x10) >> 4;
}

static rt_err_t spinand_read_dataload(struct rt_qspi_device *qspi, uint8_t u8Addr2, uint8_t u8Addr1, uint8_t u8Addr0)
{
    rt_err_t result = RT_EOK;
    uint8_t au8Cmd[4];
    uint8_t u8SR;

    au8Cmd[0] = 0x13 ;
    au8Cmd[1] = u8Addr2;
    au8Cmd[2] = u8Addr1;
    au8Cmd[3] = u8Addr0;

    if ((result = nu_qspi_send(qspi, &au8Cmd[0], sizeof(au8Cmd))) != RT_EOK)
        goto exit_spinand_read_dataload;

    if (spinand_isbusy(qspi))
    {
        result = -RT_EIO;
        goto exit_spinand_read_dataload;
    }

    u8SR = spinand_hwecc_status_get(SPINAND_FLASH_QSPI);
    if ((u8SR != 0x00) && (u8SR != 0x01))
    {
        result = -RT_MTD_EECC;
        LOG_E("Error ECC status error[0x%x].", u8SR);
    }

exit_spinand_read_dataload:

    return result;
}

static uint8_t spinand_block_isbad(struct rt_qspi_device *qspi, uint32_t u32PageAddr)
{
    rt_err_t result;
    uint8_t read_buf;

again_spinand_block_isbad:

    result = spinand_read_dataload(qspi, (u32PageAddr >> 16) & 0xFF, (u32PageAddr >> 8) & 0xFF, u32PageAddr & 0xFF); // Read the first page of a block
    RT_ASSERT(result == RT_EOK);

    result = spinand_normal_read(qspi, (SPINAND_FLASH_PAGE_SIZE >> 8) & 0xff, SPINAND_FLASH_PAGE_SIZE & 0xff, &read_buf, 1); // Read bad block mark at 0x800 update at v.1.0.8
    RT_ASSERT(result == RT_EOK);

    if (read_buf != 0xFF)
    {
        // update at v.1.0.7
        return 1;
    }

    if (((u32PageAddr % (SPINAND_FLASH_PAGE_PER_BLOCK_NUM * SPINAND_FLASH_PAGE_SIZE)) == 0))
    {
        /* Need check second page again. */
        u32PageAddr++;
        goto again_spinand_block_isbad;
    }

    return 0;
}

static rt_err_t spinand_buffermode_set(struct rt_qspi_device *qspi, uint8_t u8Enable)
{
    uint8_t u8SR = spinand_status_register_read(qspi, 2); // Read status register 2

    if (u8Enable)
    {
        u8SR |= 0x08; // Enable BUF bit
    }
    else
    {
        u8SR &= 0xF7; // Disable BUF bit
    }
    return spinand_status_register_write(qspi, 2, u8SR);
}

static rt_err_t spinand_block_erase(struct rt_qspi_device *qspi, uint8_t u8Addr2, uint8_t u8Addr1, uint8_t u8Addr0)
{
    rt_err_t result;
    uint8_t u8WECmd = 0x06;
    uint8_t au8EraseCmd[4], u8SR;

    au8EraseCmd[0] = 0xD8;
    au8EraseCmd[1] = u8Addr2;
    au8EraseCmd[2] = u8Addr1;
    au8EraseCmd[3] = u8Addr0;

    if ((result = nu_qspi_send(qspi, &u8WECmd, sizeof(u8WECmd))) != RT_EOK)
        goto exit_spinand_block_erase;

    if ((result = nu_qspi_send(qspi, &au8EraseCmd[0], sizeof(au8EraseCmd))) != RT_EOK)
        goto exit_spinand_block_erase;

    if (spinand_isbusy(qspi))
        return -RT_EIO;

    u8SR = spinand_program_erase_isfail(SPINAND_FLASH_QSPI);
    if (u8SR != 0)
    {
        /* Fail to erase */
        LOG_E("Fail to erase. Will mark it bad.");
        result = -RT_ERROR;
        goto exit_spinand_block_erase;
    }

exit_spinand_block_erase:

    return result;
}

static rt_err_t spinand_block_markbad(struct rt_qspi_device *qspi,  uint32_t u32PageAddr)
{
    rt_err_t result = RT_EOK;

    uint8_t u8BadBlockMarker = 0xF0;

    result = spinand_block_erase(qspi, (u32PageAddr >> 16) & 0xFF, (u32PageAddr >> 8) & 0xFF, u32PageAddr & 0xFF);
    if (result != RT_EOK)
        return result;

    result = spinand_program_dataload(qspi, (SPINAND_FLASH_PAGE_SIZE >> 8) & 0xff, SPINAND_FLASH_PAGE_SIZE & 0xff, &u8BadBlockMarker, 1, 0, 0);
    if (result != RT_EOK)
        return result;

    return spinand_program_execute(qspi, (u32PageAddr >> 16) & 0xFF, (u32PageAddr >> 8) & 0xFF, u32PageAddr & 0xFF);
}

static rt_err_t spinand_read_quadoutput(
    struct rt_qspi_device *qspi,
    uint8_t u8AddrH,
    uint8_t u8AddrL,
    uint8_t *pu8DataBuff,
    uint32_t u32DataCount
)
{
    struct rt_qspi_message qspi_messages = {0};

    /* 1-bit mode */
    qspi_messages.instruction.content    = SPINAND_FLASH_QUADREAD_CMDID;
    qspi_messages.instruction.qspi_lines = 1;

    qspi_messages.address.content = (u8AddrH << 8) | (u8AddrL);
    qspi_messages.address.size = 2 * 8;
    qspi_messages.address.qspi_lines = 1;

    qspi_messages.dummy_cycles = SPINAND_FLASH_DUMMYBYTE * 8; //In bit

    /* 4-bit mode */
    qspi_messages.qspi_data_lines   = 4;
    qspi_messages.parent.cs_take    = 1;
    qspi_messages.parent.cs_release = 1;
    qspi_messages.parent.recv_buf   = pu8DataBuff;
    qspi_messages.parent.length     = u32DataCount;
    qspi_messages.parent.next       = RT_NULL;

    return nu_qspi_transfer_message(qspi, (struct rt_qspi_message *) &qspi_messages);
}

661
rt_err_t spinand_jedecid_get(struct rt_qspi_device *qspi, uint32_t *pu32ID)
W
Wayne Lin 已提交
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 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
{
    uint32_t u32JedecId = 0;
    uint32_t u32JedecId_real = 0;
    uint8_t u8Cmd = 0x9F;

    if (nu_qspi_send_then_recv(qspi, &u8Cmd, 1, &u32JedecId, 4) != RT_EOK)
    {
        return -RT_ERROR;
    }

    /* Reverse order. */
    nu_set32_be((uint8_t *)&u32JedecId_real, u32JedecId);

    /* Only keep 3-bytes. */
    u32JedecId_real &= 0x00ffffff;

    *pu32ID = u32JedecId_real;

    return RT_EOK;
}

static rt_err_t spinand_reset(struct rt_qspi_device *qspi)
{
    rt_err_t result;
    uint8_t u8Cmd = 0xFF;

    if ((result = nu_qspi_send(qspi, &u8Cmd, 1)) != RT_EOK)
        goto exit_spinand_reset;

    if (spinand_isbusy(qspi))
    {
        result = RT_EIO;
        goto exit_spinand_reset;
    }

exit_spinand_reset:

    return result;
}

rt_err_t spinand_flash_init(struct rt_qspi_device *qspi)
{
    rt_err_t result;

    if ((result = spinand_reset(qspi)) != RT_EOK)
        goto  exit_spinand_init;

    if ((result = spinand_info_read(qspi)) != RT_EOK)
        goto exit_spinand_init;

    /* Un-protect */
    if ((result = spinand_protect_set(qspi, 0)) != RT_EOK)
        goto exit_spinand_init;

    /* Enable BUF mode */
    if ((result = spinand_buffermode_set(qspi, 1)) != RT_EOK)
        goto exit_spinand_init;

    /* Enable HWECC */
    if ((result = spinand_hwecc_set(qspi, 1)) != RT_EOK)
        goto exit_spinand_init;

    /* Check HWECC */
    if (!(spinand_hwecc_get(qspi)))
        goto exit_spinand_init;

    if (SPINAND_FLASH_MCP == 1)
    {
        /* Select die. */
        if ((result = spinand_die_select(qspi, SPINAND_DIE_ID1)) != RT_EOK)
            goto exit_spinand_init;

        /* Unprotect */
        if ((result = spinand_protect_set(qspi, 0)) != RT_EOK)
            goto exit_spinand_init;
    }

    LOG_I("Enabled BUF, HWECC. Unprotected.");

exit_spinand_init:

    return -result;
}

746 747 748 749 750 751 752 753 754 755
int spinand_supported_flash_size(void)
{
    return SPINAND_LIST_ELEMENT_NUM;
}

nu_spinand_info_t spinand_info_get(int idx)
{
    return (nu_spinand_info_t)&g_spinandflash_list[idx];
}

W
Wayne Lin 已提交
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
struct spinand_ops spinand_ops_wb =
{
    .block_erase      = spinand_block_erase,
    .block_isbad      = spinand_block_isbad,
    .block_markbad    = spinand_block_markbad,
    .die_select       = spinand_die_select,
    .jedecid_get      = spinand_jedecid_get,
    .program_dataload = spinand_program_dataload,
    .program_execute  = spinand_program_execute,
    .read_dataload    = spinand_read_dataload,
    .read_quadoutput  = spinand_read_quadoutput
};

static rt_err_t spinand_info_read(struct rt_qspi_device *qspi)
{
    int i;
    uint32_t u32JedecId = 0;

    if (spinand_jedecid_get(qspi, &u32JedecId) != RT_EOK)
        goto exit_spinand_info_read;

    for (i = 0 ; i < SPINAND_LIST_ELEMENT_NUM; i++)
    {
        if (u32JedecId == g_spinandflash_list[i].u32JEDECID)   /* Match JEDECID? */
        {
781 782 783
            rt_memcpy((void *)&spinand_flash_data_layout[0], (void *)&g_spinandflash_list[i].au8DataLayout[0], SPINAND_SPARE_LAYOUT_SIZE);
            rt_memcpy((void *)&spinand_flash_ecc_layout[0], (void *)&g_spinandflash_list[i].au8EccLayout[0], SPINAND_SPARE_LAYOUT_SIZE);

W
Wayne Lin 已提交
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
            rt_memcpy(SPINAND_FLASH_INFO, &g_spinandflash_list[i], sizeof(struct nu_spinand_info));
            LOG_I("Found: [%08X] %s.", u32JedecId, SPINAND_FLASH_DESCRIPTION);

            switch (u32JedecId & 0xff0000)
            {
            case 0xEF0000: /* Winbond */
                SPINAND_FLASH_OPS = &spinand_ops_wb;
                break;

            default:
                goto exit_spinand_info_read;
            }

            return RT_EOK;
        }
    }

exit_spinand_info_read:

    LOG_E("Can't find the flash[%08X] in supported list.", u32JedecId);
    return -RT_ERROR;
}

#endif