aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/lib/complex/m25q/m25q.h
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2018-10-03 12:24:19 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2018-10-03 12:24:19 +0000
commitf31a721399d17465a96ab32767ffb351540165ce (patch)
tree06935f6eb127a3440bd79e23a9d6522b03e434cb /os/hal/lib/complex/m25q/m25q.h
parent261d0c7a7708b1aab34d57ca7933f6dcf330b1cd (diff)
downloadChibiOS-f31a721399d17465a96ab32767ffb351540165ce.tar.gz
ChibiOS-f31a721399d17465a96ab32767ffb351540165ce.tar.bz2
ChibiOS-f31a721399d17465a96ab32767ffb351540165ce.zip
Renamed ambiguous m25q subsystem.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12318 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/lib/complex/m25q/m25q.h')
-rw-r--r--os/hal/lib/complex/m25q/m25q.h182
1 files changed, 0 insertions, 182 deletions
diff --git a/os/hal/lib/complex/m25q/m25q.h b/os/hal/lib/complex/m25q/m25q.h
deleted file mode 100644
index d33dd9f48..000000000
--- a/os/hal/lib/complex/m25q/m25q.h
+++ /dev/null
@@ -1,182 +0,0 @@
-/*
- ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-*/
-
-/**
- * @file m25q.h
- * @brief M25Q serial flash driver header.
- *
- * @addtogroup M25Q
- * @ingroup M25Q
- * @{
- */
-
-#ifndef M25Q_H
-#define M25Q_H
-
-#include "hal_jesd216_flash.h"
-
-/*===========================================================================*/
-/* Driver constants. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Driver pre-compile time settings. */
-/*===========================================================================*/
-
-/**
- * @name Configuration options
- * @{
- */
-/**
- * @brief Number of dummy cycles for fast read (1..15).
- * @details This is the number of dummy cycles to be used for fast read
- * operations.
- */
-#if !defined(M25Q_READ_DUMMY_CYCLES) || defined(__DOXYGEN__)
-#define M25Q_READ_DUMMY_CYCLES 8
-#endif
-
-/**
- * @brief Switch QSPI bus width on initialization.
- * @details A bus width initialization is performed by writing the
- * Enhanced Volatile Configuration Register. If the flash
- * device is configured using the Non Volatile Configuration
- * Register then this option is not required.
- * @note This option is only valid in QSPI bus modes.
- */
-#if !defined(M25Q_SWITCH_WIDTH) || defined(__DOXYGEN__)
-#define M25Q_SWITCH_WIDTH TRUE
-#endif
-
-/**
- * @brief Delays insertions.
- * @details If enabled this options inserts delays into the flash waiting
- * routines releasing some extra CPU time for threads with lower
- * priority, this may slow down the driver a bit however.
- */
-#if !defined(M25Q_NICE_WAITING) || defined(__DOXYGEN__)
-#define M25Q_NICE_WAITING TRUE
-#endif
-
-/**
- * @brief Uses 4kB sub-sectors rather than 64kB sectors.
- */
-#if !defined(M25Q_USE_SUB_SECTORS) || defined(__DOXYGEN__)
-#define M25Q_USE_SUB_SECTORS FALSE
-#endif
-
-/**
- * @brief Size of the compare buffer.
- * @details This buffer is allocated in the stack frame of the function
- * @p flashVerifyErase() and its size must be a power of two.
- * Larger buffers lead to better verify performance but increase
- * stack usage for that function.
- */
-#if !defined(M25Q_COMPARE_BUFFER_SIZE) || defined(__DOXYGEN__)
-#define M25Q_COMPARE_BUFFER_SIZE 32
-#endif
-/** @} */
-
-/*===========================================================================*/
-/* Derived constants and error checks. */
-/*===========================================================================*/
-
-#if (M25Q_READ_DUMMY_CYCLES < 1) || (M25Q_READ_DUMMY_CYCLES > 15)
-#error "invalid M25Q_READ_DUMMY_CYCLES value (1..15)"
-#endif
-
-#if (M25Q_COMPARE_BUFFER_SIZE & (M25Q_COMPARE_BUFFER_SIZE - 1)) != 0
-#error "invalid M25Q_COMPARE_BUFFER_SIZE value"
-#endif
-
-/*===========================================================================*/
-/* Driver data structures and types. */
-/*===========================================================================*/
-
-/**
- * @brief Type of a M25Q configuration structure.
- */
-typedef struct {
- _jesd216_config
-} M25QConfig;
-
-/**
- * @brief @p M25Q specific methods.
- */
-#define _m25q_methods \
- _jesd216_flash_methods
-
-/**
- * @extends JESD216FlashVMT
- *
- * @brief @p M25Q virtual methods table.
- */
-struct M25QDriverVMT {
- _m25q_methods
-};
-
-/**
- * @extends JESD216Flash
- *
- * @brief Type of M25Q flash class.
- */
-typedef struct {
- /**
- * @brief M25QDriver Virtual Methods Table.
- */
- const struct M25QDriverVMT *vmt;
- _jesd216_flash_data
- /**
- * @brief Current configuration data.
- */
- const M25QConfig *config;
- /**
- * @brief Device ID and unique ID.
- */
- uint8_t device_id[20];
-} M25QDriver;
-
-/*===========================================================================*/
-/* Driver macros. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* External declarations. */
-/*===========================================================================*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
- void m25qObjectInit(M25QDriver *devp);
- void m25qStart(M25QDriver *devp, const M25QConfig *config);
- void m25qStop(M25QDriver *devp);
-#if (JESD216_BUS_MODE != JESD216_BUS_MODE_SPI) || defined(__DOXYGEN__)
-#if (QSPI_SUPPORTS_MEMMAP == TRUE) || defined(__DOXYGEN__)
- void m25qMemoryMap(M25QDriver *devp, uint8_t ** addrp);
- void m25qMemoryUnmap(M25QDriver *devp);
-#endif /* QSPI_SUPPORTS_MEMMAP == TRUE */
-#endif /* JESD216_BUS_MODE != JESD216_BUS_MODE_SPI */
-#ifdef __cplusplus
-}
-#endif
-
-/* Device-specific implementations.*/
-#include "m25q_flash.h"
-
-#endif /* M25Q_H */
-
-/** @} */
-