summaryrefslogtreecommitdiffstats
path: root/bsps/arm/lpc32xx/nand/nand-mlc-erase-block-safe.c
blob: 37243ca0ce33d4f084354507e4b70c80a72ad44a (plain) (blame)
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
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
126
127
128
129
130
131
132
133
134
135
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup lpc32xx_nand_mlc
 *
 * @brief lpc32xx_mlc_erase_block_safe(), lpc32xx_mlc_erase_block_safe_3(), and
 * lpc32xx_mlc_zero_block() implementation.
 */

/*
 * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * 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 OWNER 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.
 */

#include <bsp/nand-mlc.h>

#include <string.h>

#include <bsp.h>

void lpc32xx_mlc_zero_pages(uint32_t page_begin, uint32_t page_end)
{
  uint32_t page = 0;

  for (page = page_begin; page < page_end; ++page) {
    lpc32xx_mlc_write_page_with_ecc(
      page,
      lpc32xx_magic_zero_begin,
      lpc32xx_magic_zero_begin
    );
  }
}

static rtems_status_code is_valid_page(
  uint32_t page_begin,
  uint32_t page_offset
)
{
  rtems_status_code sc = RTEMS_SUCCESSFUL;
  uint32_t spare [MLC_LARGE_SPARE_WORD_COUNT];

  memset(spare, 0, MLC_LARGE_SPARE_SIZE);

  sc = lpc32xx_mlc_read_page(
    page_begin + page_offset,
    lpc32xx_magic_zero_begin,
    spare,
    NULL
  );
  if (sc == RTEMS_SUCCESSFUL) {
    if (lpc32xx_mlc_is_bad_page(spare)) {
      sc = RTEMS_INCORRECT_STATE;
    }
  }

  return sc;
}

static rtems_status_code is_valid_block(uint32_t page_begin)
{
  rtems_status_code sc = RTEMS_SUCCESSFUL;

  if (lpc32xx_mlc_page_size() == 512 && lpc32xx_mlc_io_width() == 8) {
    sc = is_valid_page(page_begin, 0);
    if (sc == RTEMS_SUCCESSFUL) {
      sc = is_valid_page(page_begin, 1);
    }
  } else {
    sc = RTEMS_NOT_IMPLEMENTED;
  }

  return sc;
}

rtems_status_code lpc32xx_mlc_is_valid_block(uint32_t block_index)
{
  uint32_t pages_per_block = lpc32xx_mlc_pages_per_block();
  uint32_t page_begin = block_index * pages_per_block;

  return is_valid_block(page_begin);
}

rtems_status_code lpc32xx_mlc_erase_block_safe_3(
  uint32_t block_index,
  uint32_t page_begin,
  uint32_t page_end
)
{
  rtems_status_code sc = RTEMS_SUCCESSFUL;

  sc = is_valid_block(page_begin);
  if (sc == RTEMS_SUCCESSFUL) {
    sc = lpc32xx_mlc_erase_block(block_index);
    if (sc == RTEMS_UNSATISFIED) {
      lpc32xx_mlc_zero_pages(page_begin, page_end);
    }
  }

  return sc;
}

rtems_status_code lpc32xx_mlc_erase_block_safe(uint32_t block_index)
{
  uint32_t pages_per_block = lpc32xx_mlc_pages_per_block();
  uint32_t page_begin = block_index * pages_per_block;
  uint32_t page_end = page_begin + pages_per_block;

  return lpc32xx_mlc_erase_block_safe_3(
    block_index,
    page_begin,
    page_end
  );
}