m25p.h

Go to the documentation of this file.

/* Copyright 2013-2014, Peter A. Bigot
 *
 * 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 the software 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.
 */

#ifndef BSP430_UTILITY_M25P_H
#define BSP430_UTILITY_M25P_H

#include <bsp430/core.h>
#include <bsp430/serial.h>
#include <bsp430/periph/port.h>

#ifndef configBSP430_PLATFORM_M25P
#define configBSP430_PLATFORM_M25P 0
#endif /* configBSP430_PLATFORM_M25P */

#if defined(BSP430_DOXYGEN)
#define BSP430_PLATFORM_M25P include <bsp430/platform.h>
#endif /* BSP430_DOXYGEN */

#if defined(BSP430_DOXYGEN) || ! defined(BSP430_PLATFORM_M25P_SPI_CTL0_BYTE)

#define BSP430_PLATFORM_M25P_SPI_CTL0_BYTE BSP430_SERIAL_ADJUST_CTL0_INITIALIZER(UCCKPL | UCMSB | UCMST)
#endif /* BSP430_PLATFORM_M25P_SPI_CTL0_BYTE */

#if defined(BSP430_DOXYGEN)

#define BSP430_PLATFORM_M25P_SPI_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_PWR_PORT_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_PWR_PORT_BIT include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_RSTn_PORT_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_RSTn_PORT_BIT include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_CSn_PORT_PERIPH_HANDLE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_CSn_PORT_BIT include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_SUPPORTS_PE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_SUPPORTS_PW include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_SECTOR_SIZE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_SUBSECTOR_SIZE include <bsp430/platform.h>

#define BSP430_PLATFORM_M25P_SECTOR_COUNT include <bsp430/platform.h>

#endif /* BSP430_DOXYGEN */

typedef struct sBSP430m25p {
  hBSP430halSERIAL spi;
  volatile sBSP430hplPORT * csn_port;
  volatile sBSP430hplPORT * rstn_port;
  uint8_t csn_bit;
  uint8_t rstn_bit;
} sBSP430m25p;

typedef sBSP430m25p * hBSP430m25p;

#define BSP430_M25P_CMD_WREN 0x06

#define BSP430_M25P_CMD_WRDI 0x04

#define BSP430_M25P_CMD_RDID 0x9f

#define BSP430_M25P_CMD_RDSR 0x05

#define BSP430_M25P_CMD_WRSR 0x01

#define BSP430_M25P_CMD_WRLR 0xe5

#define BSP430_M25P_CMD_RDLR 0xe8

#define BSP430_M25P_CMD_READ 0x03

#define BSP430_M25P_CMD_FAST_READ 0x0b

#define BSP430_M25P_CMD_PW 0x0a

#define BSP430_M25P_CMD_PP 0x02

#define BSP430_M25P_CMD_PE 0xdb

#define BSP430_M25P_CMD_SSE 0x20

#define BSP430_M25P_CMD_SE 0xd8

#define BSP430_M25P_CMD_BE 0xc7

#define BSP430_M25P_CMD_DP 0xb9

#define BSP430_M25P_CMD_RELDP 0xab

#define BSP430_M25P_CMD_RES 0xab

#define BSP430_M25P_SR_WIP 0x01

#define BSP430_M25P_SR_WEL 0x02

#define BSP430_M25P_SR_BP0 0x04

#define BSP430_M25P_SR_BP1 0x08

#define BSP430_M25P_SR_SRWD 0x80

#define BSP430_M25P_RESET_SET(dev_) do {                \
    if (NULL != (dev_)->rstn_port) {                    \
      (dev_)->rstn_port->out &= ~(dev_)->rstn_bit;      \
    }                                                   \
  } while (0)

#define BSP430_M25P_RESET_CLEAR(dev_) do {              \
    if (NULL != (dev_)->rstn_port) {                    \
      (dev_)->rstn_port->out |= (dev_)->rstn_bit;       \
    }                                                   \
  } while (0)

#define BSP430_M25P_CS_ASSERT(dev_) do {        \
    (dev_)->csn_port->out &= ~(dev_)->csn_bit;  \
  } while (0)

#define BSP430_M25P_CS_DEASSERT(dev_) do {      \
    (dev_)->csn_port->out |= (dev_)->csn_bit;   \
  } while (0)


hBSP430m25p hBSP430m25pInitialize (hBSP430m25p dev,
                                   unsigned char ctl0_byte,
                                   unsigned char ctl1_byte,
                                   unsigned int prescaler);

int iBSP430m25pStatus_rh (hBSP430m25p dev);

static BSP430_CORE_INLINE
int iBSP430m25pStatus (hBSP430m25p dev)
{
  BSP430_CORE_SAVED_INTERRUPT_STATE(istate);
  int rv;

  BSP430_CORE_DISABLE_INTERRUPT();
  rv = iBSP430m25pStatus_rh(dev);
  BSP430_CORE_RESTORE_INTERRUPT_STATE(istate);
  return rv;
}

int iBSP430m25pStrobeCommand_rh (hBSP430m25p dev,
                                 uint8_t cmd);

int iBSP430m25pStrobeAddressCommand_rh (hBSP430m25p dev,
                                        uint8_t cmd,
                                        unsigned long addr);

int iBSP430m25pInitiateCommand_rh (hBSP430m25p dev,
                                   uint8_t cmd);

int iBSP430m25pInitiateAddressCommand_rh (hBSP430m25p dev,
                                          uint8_t cmd,
                                          unsigned long addr);

int iBSP430m25pCompleteTxRx_rh (hBSP430m25p dev,
                                const uint8_t * tx_data,
                                size_t tx_len,
                                size_t rx_len,
                                uint8_t * rx_data);

#endif /* BSP430_UTILITY_M25P_H */