Atmel NAND Flash Controller

Atmel NAND controller 구성

NAND flash controller node는 EBI bus 아래에 정의해야 합니다. EBI 바인딩은 `Documentation/devicetree/bindings/memory-controllers/atmel,ebi.txt`를 참조합니다.

하나의 NAND controller 아래에는 NAND device를 하나 이상 정의할 수 있으며, controller는 ECC engine에 연결될 수 있습니다.

NAND controller 필수 속성

Controller `compatible`은 `atmel,at91rm9200-nand-controller`, `atmel,at91sam9260-nand-controller`, `atmel,at91sam9261-nand-controller`, `atmel,at91sam9g45-nand-controller`, `atmel,sama5d3-nand-controller`, `microchip,sam9x60-nand-controller` 중 하나입니다.

`ranges`는 EBI의 range 정의를 전달하는 빈 속성입니다. `#address-cells`는 2, `#size-cells`는 1이어야 합니다.

`atmel,nfc-io`는 NFC I/O block의 phandle이고 `atmel,nfc-sram`은 NFC SRAM block의 phandle입니다. 둘 다 SAMA5D3 controller에서만 필수입니다.

선택 `ecc-engine`은 PMECC block의 phandle입니다. SoC에 PMECC engine이 내장된 경우에만 의미가 있습니다.

NAND device·chip 속성

Chip의 필수 `reg`는 NAND device에 할당된 chip-select line을 기술합니다. 여러 CS line을 노출하는 multi-die chip이라면 `reg`에 세 entry로 이루어진 tuple을 X개 넣습니다.

각 tuple의 첫 entry는 chip이 연결된 CS line이고, 두 번째는 device에 할당된 memory 영역의 base offset으로 항상 0이며, 세 번째는 memory 영역 크기로 항상 `0x800000`입니다.

선택 `rb-gpios`는 Ready/Busy 상태를 확인하는 GPIO, `cs-gpios`는 CS line 제어 GPIO, `det-gpios`는 SmartMedia Card 존재 감지 GPIO입니다. `atmel,rb`는 native Ready/Busy pin을 식별하는 정수이며 SAMA5 SoC에서만 의미가 있습니다.

모든 generic 속성은 `Documentation/devicetree/bindings/mtd/` 아래의 generic YAML 파일에 설명되어 있습니다.

PMECC engine 바인딩

PMECC `compatible`은 `atmel,at91sam9g45-pmecc`, `atmel,sama5d4-pmecc`, `atmel,sama5d2-pmecc`, `microchip,sam9x60-pmecc` 중 하나입니다. SAM9X7은 `microchip,sam9x7-pmecc`와 fallback `atmel,at91sam9g45-pmecc`를 함께 사용합니다.

`reg`에는 register 범위 두 개를 넣습니다. 첫 범위는 PMECC block, 두 번째 범위는 `PMECC_ERRLOC` block을 가리킵니다.

SAMA5D3 EBI·PMECC 예제

예제는 `nfc_io` syscon, 두 register 범위를 갖는 PMECC, SAMA5D3 EBI, 그 아래 NAND controller와 CS3의 NAND chip을 계층적으로 정의합니다.

Controller는 NFC SRAM·I/O와 PMECC를 phandle로 연결하고 `#address-cells = <2>`, `#size-cells = <1>`, 빈 `ranges`를 사용합니다. `nand@3`의 tuple은 CS3, offset 0, 크기 `0x800000`이며 native Ready/Busy pin 0을 선택합니다.

nfc_io: nfc-io@70000000 {
        compatible = "atmel,sama5d3-nfc-io", "syscon";
        reg = <0x70000000 0x8000000>;
};

pmecc: ecc-engine@ffffc070 {
        compatible = "atmel,at91sam9g45-pmecc";
        reg = <0xffffc070 0x490>,
              <0xffffc500 0x100>;
};

ebi: ebi@10000000 {
        compatible = "atmel,sama5d3-ebi";
        #address-cells = <2>;
        #size-cells = <1>;
        atmel,smc = <&hsmc>;
        reg = <0x10000000 0x10000000
               0x40000000 0x30000000>;
        ranges = <0x0 0x0 0x10000000 0x10000000
                  0x1 0x0 0x40000000 0x10000000
                  0x2 0x0 0x50000000 0x10000000
                  0x3 0x0 0x60000000 0x10000000>;
        clocks = <&mck>;

        nand_controller: nand-controller {
                compatible = "atmel,sama5d3-nand-controller";
                atmel,nfc-sram = <&nfc_sram>;
                atmel,nfc-io = <&nfc_io>;
                ecc-engine = <&pmecc>;
                #address-cells = <2>;
                #size-cells = <1>;
                ranges;

                nand@3 {
                        reg = <0x3 0x0 0x800000>;
                        atmel,rb = <0>;

                        /*
                         * Put generic NAND/MTD properties and
                         * subnodes here.
                         */
                };
        };
};

Deprecated 단일-node 필수 속성

구식 바인딩은 새 device tree에서 사용하면 안 됩니다. 가능한 `compatible`은 `atmel,at91rm9200-nand`, `atmel,sama5d2-nand`, `atmel,sama5d4-nand`입니다.

`reg`는 chip의 localbus 주소와 크기, 사용 가능한 hardware ECC controller를 지정합니다. PMECC를 쓸 때는 PMECC와 PMECC Error Location controller의 주소·크기를 포함하며, ROM의 PMECC lookup table 주소·크기는 선택입니다. 생략하면 driver가 runtime에 table을 생성합니다.

`atmel,nand-addr-offset`은 address latch offset, `atmel,nand-cmd-offset`은 command latch offset입니다. Partition subnode가 있으면 `#address-cells`와 `#size-cells`가 필수입니다.

`gpios`는 NAND를 제어하는 GPIO pin을 지정합니다. Detect GPIO는 선택이며 없으면 0으로 설정할 수 있습니다.

Deprecated DMA·ECC 선택 속성

`atmel,nand-has-dma`는 NAND read/write DMA 전송을 활성화합니다. `nand-ecc-mode`의 기본값은 `soft`이고 허용값은 `none`, `soft`, `hw`, `hw_syndrome`, `hw_oob_first`, `soft_bch`입니다.

`atmel,has-pmecc`는 BCH encode·decode가 가능한 Programmable Multibit ECC hardware를 활성화합니다. `atmel,pmecc-cap`의 지원 correction capability는 2, 4, 8, 12, 24이고, `atmel,sama5d2-nand`에서는 32도 유효합니다. `atmel,pmecc-sector-size`는 512 또는 1024입니다.

`atmel,pmecc-lookup-table-offset`은 ROM에 있는 두 lookup table offset을 담으며 첫 값은 sector 512, 다음 값은 sector 1024용입니다. 생략하면 driver가 runtime에 table을 만듭니다.

`nand-bus-width`는 8 또는 16이고 생략 시 8입니다. `nand-on-flash-bbt`는 on-flash BBT를 활성화하는 boolean이며 생략 시 false입니다.

Deprecated NFC 하위 node

NAND Flash Controller인 NFC는 선택 subnode입니다. 필수 `compatible`은 `atmel,sama5d3-nfc`이고, `reg`는 NFC command register, NFC register, NFC SRAM의 주소와 크기를 지정합니다. NFC SRAM을 사용하지 않으면 그 범위는 생략할 수 있습니다.

`clocks`는 peripheral clock의 phandle입니다. 선택 boolean `atmel,write-by-sram`은 SRAM을 통한 NFC write를 활성화합니다.

Legacy software ECC 예제

첫 legacy 예제는 localbus와 hardware ECC register 범위, ALE offset 21, CLE offset 22, on-flash BBT와 software ECC를 설정합니다. GPIO 순서는 ready, chip-enable, 선택 card-detect이며 partition subnode를 포함합니다.

nand0: nand@40000000,0 {
        compatible = "atmel,at91rm9200-nand";
        #address-cells = <1>;
        #size-cells = <1>;
        reg = <0x40000000 0x10000000
               0xffffe800 0x200
              >;
        atmel,nand-addr-offset = <21>;        /* ale */
        atmel,nand-cmd-offset = <22>;        /* cle */
        nand-on-flash-bbt;
        nand-ecc-mode = "soft";
        gpios = <&pioC 13 0        /* rdy */
                 &pioC 14 0         /* nce */
                 0                /* cd */
                >;
        partition@0 {
                ...
        };
};

Legacy PMECC 예제

두 번째 예제는 bus, PMECC, `PMECC ERRLOC`, ROM lookup table 범위를 함께 제공하고 hardware ECC와 PMECC를 활성화합니다. Correction capability는 2, sector는 512, lookup table offset은 `0x8000`과 `0x10000`입니다.

/* for PMECC supported chips */
nand0: nand@40000000 {
        compatible = "atmel,at91rm9200-nand";
        #address-cells = <1>;
        #size-cells = <1>;
        reg = < 0x40000000 0x10000000        /* bus addr & size */
                0xffffe000 0x00000600        /* PMECC addr & size */
                0xffffe600 0x00000200        /* PMECC ERRLOC addr & size */
                0x00100000 0x00100000        /* ROM addr & size */
                >;
        atmel,nand-addr-offset = <21>;        /* ale */
        atmel,nand-cmd-offset = <22>;        /* cle */
        nand-on-flash-bbt;
        nand-ecc-mode = "hw";
        atmel,has-pmecc;        /* enable PMECC */
        atmel,pmecc-cap = <2>;
        atmel,pmecc-sector-size = <512>;
        atmel,pmecc-lookup-table-offset = <0x8000 0x10000>;
        gpios = <&pioD 5 0        /* rdy */
                 &pioD 4 0        /* nce */
                 0                /* cd */
                >;
        partition@0 {
                ...
        };
};

Legacy NFC 예제

세 번째 예제는 NAND node 아래에 `atmel,sama5d3-nfc` subnode를 두고 command register, HSMC register, SRAM bank의 세 범위를 지정합니다. 원문에서 `clocks = <&hsmc_clk>` 뒤 semicolon이 빠진 상태도 그대로 보존합니다.

/* for NFC supported chips */
nand0: nand@40000000 {
        compatible = "atmel,at91rm9200-nand";
        #address-cells = <1>;
        #size-cells = <1>;
        ranges;
        ...
        nfc@70000000 {
                compatible = "atmel,sama5d3-nfc";
                #address-cells = <1>;
                #size-cells = <1>;
                clocks = <&hsmc_clk>
                reg = <
                        0x70000000 0x10000000        /* NFC Command Registers */
                        0xffffc000 0x00000070        /* NFC HSMC regs */
                        0x00200000 0x00100000        /* NFC SRAM banks */
                >;
        };
};