Skip to content

Commit

Permalink
tests/mtd_spi_nor: Added new tests
Browse files Browse the repository at this point in the history
  • Loading branch information
crasbe committed Apr 24, 2024
1 parent 1e2953d commit 8509a22
Show file tree
Hide file tree
Showing 6 changed files with 404 additions and 0 deletions.
11 changes: 11 additions & 0 deletions tests/drivers/mtd_spi_nor/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
BOARD ?= nrf52840dk

include ../Makefile.drivers_common

USEMODULE += embunit
USEMODULE += mtd_spi_nor

CFLAGS += -DTHREAD_STACKSIZE_MAIN=4096
CFLAGS += -DISR_STACKSIZE=2048

include $(RIOTBASE)/Makefile.include
3 changes: 3 additions & 0 deletions tests/drivers/mtd_spi_nor/Makefile.ci
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
BOARD_INSUFFICIENT_MEMORY := \
atmega8 \
#
41 changes: 41 additions & 0 deletions tests/drivers/mtd_spi_nor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Test Program for the MTD SPI NOR Flash Driver

This program performs a number of tests with the MTD SPI NOR Flash driver,
including reading, writing and erasing of the chip.

This test will destroy the data present on the chip!

# Usage

## nRF52830DK
The test is designed to work with the built-in MX25F6435F flash of the
Nordic Semiconductor nRF52840DK development board.
Currently the nRF52840DK Flash definitions do not have the security options enabled.

To run the test you simply have to compile and run the test:
```
make flash term
```

The tests should conclude with "OK (4 tests)".

## nRF52840DK with different flash chips

The default SPI Device for using different Flash chips is SPI(0), which is present on
the Arduino Uno style headers. The default pin for Chip Select is P1.5. The SPI Device and
Chip Select pin can be changed with CFLAGS:
```
CFLAGS+="-DFLASH_SPI_DEV=1 -DFLASH_SPI_CS='GPIO_PIN(1,5)'" make flash term
```

The Device under Test can be changed with CFLAGS as well:
```
CFLAGS+="-DTEST_MX25F12873F" make flash term
```

# Tested/Supported Chips

## Macronix

- M25F6435F (built-in on nRF52840DK)
- M25F12873F
68 changes: 68 additions & 0 deletions tests/drivers/mtd_spi_nor/flash_dut.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/*
* Copyright (C) 2024 Technische Universität Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @{
*
* @file
* @brief Definitions for different Flash chips that can be tested
*
* @author Christopher Büchse <christopher.buechse@tuhh.de>
*/

#include "timex.h"
#include "mtd_spi_nor.h"

#include "include/flash_dut.h"

#ifdef TEST_MX25L12873F

#define MX25L12873F_PAGE_SIZE (256)
#define MX25L12873F_PAGES_PER_SECTOR (16)
#define MX25L12873F_SECTOR_COUNT (4096)
#define MX25L12873F_FLAGS (SPI_NOR_F_SECT_4K | SPI_NOR_F_SECT_32K | \
SPI_NOR_F_SECT_64K | SPI_NOR_F_MX_SECUR)
#define MX25L12873F_SPI_CLK SPI_CLK_10MHZ
#define MX25L12873F_SPI_MODE SPI_MODE_0

#ifndef FLASH_SPI_CS
#define FLASH_SPI_CS GPIO_PIN(1, 5)
#endif

#ifndef FLASH_SPI_DEV
#define FLASH_SPI_DEV 0
#endif

static const mtd_spi_nor_params_t _mx25l12873f_flash_nor_params = {
.opcode = &mtd_spi_nor_opcode_macronix,
.wait_chip_erase = 50LU * US_PER_SEC,
.wait_32k_erase = 240LU *US_PER_MS,
.wait_sector_erase = 40LU * US_PER_MS,
.wait_chip_wake_up = 35LU * US_PER_MS,
.clk = MX25L12873F_SPI_CLK,
.flag = MX25L12873F_FLAGS,
.spi = SPI_DEV(FLASH_SPI_DEV),
.mode = MX25L12873F_SPI_MODE,
.cs = FLASH_SPI_CS,
.wp = GPIO_UNDEF,
.hold = GPIO_UNDEF,
};

static mtd_spi_nor_t _mx25l12873f_nor_dev = {
.base = {
.driver = &mtd_spi_nor_driver,
.page_size = MX25L12873F_PAGE_SIZE,
.pages_per_sector = MX25L12873F_PAGES_PER_SECTOR,
.sector_count = MX25L12873F_SECTOR_COUNT,
},
.params = &_mx25l12873f_flash_nor_params,
};

MTD_XFA_ADD(_mx25l12873f_nor_dev, 10);

#endif /* TEST_MX25L12873F */
/** @} */
30 changes: 30 additions & 0 deletions tests/drivers/mtd_spi_nor/include/flash_dut.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright (C) 2024 Technische Universität Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @{
*
* @file
* @brief Definitions for different Flash chips that can be tested
*
* @author Christopher Büchse <christopher.buechse@tuhh.de>
*/

#ifndef FLASH_DUT_H
#define FLASH_DUT_H

#ifdef __cplusplus
extern "C"
{
#endif

#ifdef __cplusplus
}
#endif

/** @} */
#endif /* FLASH_DUT_H */

0 comments on commit 8509a22

Please sign in to comment.