// Copyright 2007, Google Inc.
// 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 Google Inc. 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
// 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.


// Google Mock - a framework for writing C++ mock classes.
//
// This file tests the internal utilities.

#include "gmock/internal/gmock-internal-utils.h"

#include <stdlib.h>

#include <cstdint>
#include <map>
#include <memory>
#include <sstream>
#include <string>
#include <vector>

#include "gmock/gmock.h"
#include "gmock/internal/gmock-port.h"
#include "gtest/gtest-spi.h"
#include "gtest/gtest.h"

// Indicates that this translation unit is part of Google Test's
// implementation.  It must come before gtest-internal-inl.h is
// included, or there will be a compiler error.  This trick is to
// prevent a user from accidentally including gtest-internal-inl.h in
// their code.
#define GTEST_IMPLEMENTATION_ 1
#include "src/gtest-internal-inl.h"
#undef GTEST_IMPLEMENTATION_

#if GTEST_OS_CYGWIN
# include <sys/types.h>  // For ssize_t. NOLINT
#endif

namespace proto2 {
class Message;
}  // namespace proto2

namespace testing {
namespace internal {

namespace {

TEST(JoinAsTupleTest, JoinsEmptyTuple) {
  EXPECT_EQ("", JoinAsTuple(Strings()));
}

TEST(JoinAsTupleTest, JoinsOneTuple) {
  const char* fields[] = {"1"};
  EXPECT_EQ("1", JoinAsTuple(Strings(fields, fields + 1)));
}

TEST(JoinAsTupleTest, JoinsTwoTuple) {
  const char* fields[] = {"1", "a"};
  EXPECT_EQ("(1, a)", JoinAsTuple(Strings(fields, fields + 2)));
}

TEST(JoinAsTupleTest, JoinsTenTuple) {
  const char* fields[] = {"1", "2", "3", "4", "5", "6", "7", "8", "9", "10"};
  EXPECT_EQ("(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)",
            JoinAsTuple(Strings(fields, fields + 10)));
}

TEST(ConvertIdentifierNameToWordsTest, WorksWhenNameContainsNoWord) {
  EXPECT_EQ("", ConvertIdentifierNameToWords(""));
  EXPECT_EQ("", ConvertIdentifierNameToWords("_"));
  EXPECT_EQ("", ConvertIdentifierNameToWords("__"));
}

TEST(ConvertIdentifierNameToWordsTest, WorksWhenNameContainsDigits) {
  EXPECT_EQ("1", ConvertIdentifierNameToWords("_1"));
  EXPECT_EQ("2", ConvertIdentifierNameToWords("2_"));
  EXPECT_EQ("34", ConvertIdentifierNameToWords("_34_"));
  EXPECT_EQ("34 56", ConvertIdentifierNameToWords("_34_56"));
}

TEST(ConvertIdentifierNameToWordsTest, WorksWhenNameContainsCamelCaseWords) {
  EXPECT_EQ("a big word", ConvertIdentifierNameToWords("ABigWord"));
  EXPECT_EQ("foo bar", ConvertIdentifierNameToWords("FooBar"));
  EXPECT_EQ("foo", ConvertIdentifierNameToWords("Foo_"));
  EXPECT_EQ("foo bar", ConvertIdentifierNameToWords("_Foo_Bar_"));
  EXPECT_EQ("foo and bar", ConvertIdentifierNameToWords("_Foo__And_Bar"));
}

TEST(ConvertIdentifierNameToWordsTest, WorksWhenNameContains_SeparatedWords) {
  EXPECT_EQ("foo bar", ConvertIdentifierNameToWords("foo_bar"));
  EXPECT_EQ("foo", ConvertIdentifierNameToWords("_foo_"));
  EXPECT_EQ("foo bar", ConvertIdentifierNameToWords("_foo_bar_"));
  EXPECT_EQ("foo and bar", ConvertIdentifierNameToWords("_foo__and_bar"));
}

TEST(ConvertIdentifierNameToWordsTest, WorksWhenNameIsMixture) {
  EXPECT_EQ("foo bar 123", ConvertIdentifierNameToWords("Foo_bar123"));
  EXPECT_EQ("chapter 11 section 1",
            ConvertIdentifierNameToWords("_Chapter11Section_1_"));
}

TEST(PointeeOfTest, WorksForSmartPointers) {
  EXPECT_TRUE(
      (std::is_same<int, PointeeOf<std::unique_ptr<int>>::type>::value));
  EXPECT_TRUE(
      (std::is_same<std::string,
                    PointeeOf<std::shared_ptr<std::string>>::type>::value));
}

TEST(PointeeOfTest, WorksForRawPointers) {
  EXPECT_TRUE((std::is_same<int, PointeeOf<int*>::type>::value));
  EXPECT_TRUE((std::is_same<const char, PointeeOf<const char*>::type>::value));
  EXPECT_TRUE((std::is_void<PointeeOf<void*>::type>::value));
}

TEST(GetRawPointerTest, WorksForSmartPointers) {
  const char* const raw_p1 = new const char('a');  // NOLINT
  const std::unique_ptr<const char> p1(raw_p1);
  EXPECT_EQ(raw_p1, GetRawPointer(p1));
  double* const raw_p2 = new double(2.5);  // NOLINT
  const std::shared_ptr<double> p2(raw_p2);
  EXPECT_EQ(raw_p2, GetRawPointer(p2));
}

TEST(GetRawPointerTest, WorksForRawPointers) {
  int* p = nullptr;
  EXPECT_TRUE(nullptr == GetRawPointer(p));
  int n = 1;
  EXPECT_EQ(&n, GetRawPointer(&n));
}

// Tests KindOf<T>.

class Base {};
class Derived : public Base {};

TEST(KindOfTest, Bool) {
  EXPECT_EQ(kBool, GMOCK_KIND_OF_(bool));  // NOLINT
}

TEST(KindOfTest, Integer) {
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(char));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(signed char));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(unsigned char));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(short));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(unsigned short));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(int));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(unsigned int));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(long));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(unsigned long));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(long long));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(unsigned long long));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(wchar_t));  // NOLINT
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(size_t));  // NOLINT
#if GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_CYGWIN
  // ssize_t is not defined on Windows and possibly some other OSes.
  EXPECT_EQ(kInteger, GMOCK_KIND_OF_(ssize_t));  // NOLINT
#endif
}

TEST(KindOfTest, FloatingPoint) {
  EXPECT_EQ(kFloatingPoint, GMOCK_KIND_OF_(float));  // NOLINT
  EXPECT_EQ(kFloatingPoint, GMOCK_KIND_OF_(double));  // NOLINT
  EXPECT_EQ(kFloatingPoint, GMOCK_KIND_OF_(long double));  // NOLINT
}

TEST(KindOfTest, Other) {
  EXPECT_EQ(kOther, GMOCK_KIND_OF_(void*));  // NOLINT
  EXPECT_EQ(kOther, GMOCK_KIND_OF_(char**));  // NOLINT
  EXPECT_EQ(kOther, GMOCK_KIND_OF_(Base));  // NOLINT
}

// Tests LosslessArithmeticConvertible<T, U>.

TEST(LosslessArithmeticConvertibleTest, BoolToBool) {
  EXPECT_TRUE((LosslessArithmeticConvertible<bool, bool>::value));
}

TEST(LosslessArithmeticConvertibleTest, BoolToInteger) {
  EXPECT_TRUE((LosslessArithmeticConvertible<bool, char>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<bool, int>::value));
  EXPECT_TRUE(
      (LosslessArithmeticConvertible<bool, unsigned long>::value));  // NOLINT
}

TEST(LosslessArithmeticConvertibleTest, BoolToFloatingPoint) {
  EXPECT_TRUE((LosslessArithmeticConvertible<bool, float>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<bool, double>::value));
}

TEST(LosslessArithmeticConvertibleTest, IntegerToBool) {
  EXPECT_FALSE((LosslessArithmeticConvertible<unsigned char, bool>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<int, bool>::value));
}

TEST(LosslessArithmeticConvertibleTest, IntegerToInteger) {
  // Unsigned => larger signed is fine.
  EXPECT_TRUE((LosslessArithmeticConvertible<unsigned char, int>::value));

  // Unsigned => larger unsigned is fine.
  EXPECT_TRUE((LosslessArithmeticConvertible<
               unsigned short, uint64_t>::value));  // NOLINT

  // Signed => unsigned is not fine.
  EXPECT_FALSE((LosslessArithmeticConvertible<
                short, uint64_t>::value));  // NOLINT
  EXPECT_FALSE((LosslessArithmeticConvertible<
      signed char, unsigned int>::value));  // NOLINT

  // Same size and same signedness: fine too.
  EXPECT_TRUE((LosslessArithmeticConvertible<
               unsigned char, unsigned char>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<int, int>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<wchar_t, wchar_t>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<
               unsigned long, unsigned long>::value));  // NOLINT

  // Same size, different signedness: not fine.
  EXPECT_FALSE((LosslessArithmeticConvertible<
                unsigned char, signed char>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<int, unsigned int>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<uint64_t, int64_t>::value));

  // Larger size => smaller size is not fine.
  EXPECT_FALSE((LosslessArithmeticConvertible<long, char>::value));  // NOLINT
  EXPECT_FALSE((LosslessArithmeticConvertible<int, signed char>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<int64_t, unsigned int>::value));
}

TEST(LosslessArithmeticConvertibleTest, IntegerToFloatingPoint) {
  // Integers cannot be losslessly converted to floating-points, as
  // the format of the latter is implementation-defined.
  EXPECT_FALSE((LosslessArithmeticConvertible<char, float>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<int, double>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<
                short, long double>::value));  // NOLINT
}

TEST(LosslessArithmeticConvertibleTest, FloatingPointToBool) {
  EXPECT_FALSE((LosslessArithmeticConvertible<float, bool>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<double, bool>::value));
}

TEST(LosslessArithmeticConvertibleTest, FloatingPointToInteger) {
  EXPECT_FALSE((LosslessArithmeticConvertible<float, long>::value));  // NOLINT
  EXPECT_FALSE((LosslessArithmeticConvertible<double, int64_t>::value));
  EXPECT_FALSE((LosslessArithmeticConvertible<long double, int>::value));
}

TEST(LosslessArithmeticConvertibleTest, FloatingPointToFloatingPoint) {
  // Smaller size => larger size is fine.
  EXPECT_TRUE((LosslessArithmeticConvertible<float, double>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<float, long double>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<double, long double>::value));

  // Same size: fine.
  EXPECT_TRUE((LosslessArithmeticConvertible<float, float>::value));
  EXPECT_TRUE((LosslessArithmeticConvertible<double, double>::value));

  // Larger size => smaller size is not fine.
  EXPECT_FALSE((LosslessArithmeticConvertible<double, float>::value));
  GTEST_INTENTIONAL_CONST_COND_PUSH_()
  if (sizeof(double) == sizeof(long double)) {  // NOLINT
  GTEST_INTENTIONAL_CONST_COND_POP_()
    // In some implementations (e.g. MSVC), double and long double
    // have the same size.
    EXPECT_TRUE((LosslessArithmeticConvertible<long double, double>::value));
  } else {
    EXPECT_FALSE((LosslessArithmeticConvertible<long double, double>::value));
  }
}

// Tests the TupleMatches() template function.

TEST(TupleMatchesTest, WorksForSize0) {
  std::tuple<> matchers;
  std::tuple<> values;

  EXPECT_TRUE(TupleMatches(matchers, values));
}

TEST(TupleMatchesTest, WorksForSize1) {
  std::tuple<Matcher<int> > matchers(Eq(1));
  std::tuple<int> values1(1), values2(2);

  EXPECT_TRUE(TupleMatches(matchers, values1));
  EXPECT_FALSE(TupleMatches(matchers, values2));
}

TEST(TupleMatchesTest, WorksForSize2) {
  std::tuple<Matcher<int>, Matcher<char> > matchers(Eq(1), Eq('a'));
  std::tuple<int, char> values1(1, 'a'), values2(1, 'b'), values3(2, 'a'),
      values4(2, 'b');

  EXPECT_TRUE(TupleMatches(matchers, values1));
  EXPECT_FALSE(TupleMatches(matchers, values2));
  EXPECT_FALSE(TupleMatches(matchers, values3));
  EXPECT_FALSE(TupleMatches(matchers, values4));
}

TEST(TupleMatchesTest, WorksForSize5) {
  std::tuple<Matcher<int>, Matcher<char>, Matcher<bool>,
             Matcher<long>,  // NOLINT
             Matcher<std::string> >
      matchers(Eq(1), Eq('a'), Eq(true), Eq(2L), Eq("hi"));
  std::tuple<int, char, bool, long, std::string>  // NOLINT
      values1(1, 'a', true, 2L, "hi"), values2(1, 'a', true, 2L, "hello"),
      values3(2, 'a', true, 2L, "hi");

  EXPECT_TRUE(TupleMatches(matchers, values1));
  EXPECT_FALSE(TupleMatches(matchers, values2));
  EXPECT_FALSE(TupleMatches(matchers, values3));
}

// Tests that Assert(true, ...) succeeds.
TEST(AssertTest, SucceedsOnTrue) {
  Assert(true, __FILE__, __LINE__, "This should succeed.");
  Assert(true, __FILE__, __LINE__);  // This should succeed too.
}

// Tests that Assert(false, ...) generates a fatal failure.
TEST(AssertTest, FailsFatallyOnFalse) {
  EXPECT_DEATH_IF_SUPPORTED({
    Assert(false, __FILE__, __LINE__, "This should fail.");
  }, "");

  EXPECT_DEATH_IF_SUPPORTED({
    Assert(false, __FILE__, __LINE__);
  }, "");
}

// Tests that Expect(true, ...) succeeds.
TEST(ExpectTest, SucceedsOnTrue) {
  Expect(true, __FILE__, __LINE__, "This should succeed.");
  Expect(true, __FILE__, __LINE__);  // This should succeed too.
}

// Tests that Expect(false, ...) generates a non-fatal failure.
TEST(ExpectTest, FailsNonfatallyOnFalse) {
  EXPECT_NONFATAL_FAILURE({  // NOLINT
    Expect(false, __FILE__, __LINE__, "This should fail.");
  }, "This should fail");

  EXPECT_NONFATAL_FAILURE({  // NOLINT
    Expect(false, __FILE__, __LINE__);
  }, "Expectation failed");
}

// Tests LogIsVisible().

class LogIsVisibleTest : public ::testing::Test {
 protected:
  void SetUp() override { original_verbose_ = GMOCK_FLAG(verbose); }

  void TearDown() override { GMOCK_FLAG(verbose) = original_verbose_; }

  std::string original_verbose_;
};

TEST_F(LogIsVisibleTest, AlwaysReturnsTrueIfVerbosityIsInfo) {
  GMOCK_FLAG(verbose) = kInfoVerbosity;
  EXPECT_TRUE(LogIsVisible(kInfo));
  EXPECT_TRUE(LogIsVisible(kWarning));
}

TEST_F(LogIsVisibleTest, AlwaysReturnsFalseIfVerbosityIsError) {
  GMOCK_FLAG(verbose) = kErrorVerbosity;
  EXPECT_FALSE(LogIsVisible(kInfo));
  EXPECT_FALSE(LogIsVisible(kWarning));
}

TEST_F(LogIsVisibleTest, WorksWhenVerbosityIsWarning) {
  GMOCK_FLAG(verbose) = kWarningVerbosity;
  EXPECT_FALSE(LogIsVisible(kInfo));
  EXPECT_TRUE(LogIsVisible(kWarning));
}

#if GTEST_HAS_STREAM_REDIRECTION

// Tests the Log() function.

// Verifies that Log() behaves correctly for the given verbosity level
// and log severity.
void TestLogWithSeverity(const std::string& verbosity, LogSeverity severity,
                         bool should_print) {
  const std::string old_flag = GMOCK_FLAG(verbose);
  GMOCK_FLAG(verbose) = verbosity;
  CaptureStdout();
  Log(severity, "Test log.\n", 0);
  if (should_print) {
    EXPECT_THAT(GetCapturedStdout().c_str(),
                ContainsRegex(
                    severity == kWarning ?
                    "^\nGMOCK WARNING:\nTest log\\.\nStack trace:\n" :
                    "^\nTest log\\.\nStack trace:\n"));
  } else {
    EXPECT_STREQ("", GetCapturedStdout().c_str());
  }
  GMOCK_FLAG(verbose) = old_flag;
}

// Tests that when the stack_frames_to_skip parameter is negative,
// Log() doesn't include the stack trace in the output.
TEST(LogTest, NoStackTraceWhenStackFramesToSkipIsNegative) {
  const std::string saved_flag = GMOCK_FLAG(verbose);
  GMOCK_FLAG(verbose) = kInfoVerbosity;
  CaptureStdout();
  Log(kInfo, "Test log.\n", -1);
  EXPECT_STREQ("\nTest log.\n", GetCapturedStdout().c_str());
  GMOCK_FLAG(verbose) = saved_flag;
}

struct MockStackTraceGetter : testing::internal::OsStackTraceGetterInterface {
  std::string CurrentStackTrace(int max_depth, int skip_count) override {
    return (testing::Message() << max_depth << "::" << skip_count << "\n")
        .GetString();
  }
  void UponLeavingGTest() override {}
};

// Tests that in opt mode, a positive stack_frames_to_skip argument is
// treated as 0.
TEST(LogTest, NoSkippingStackFrameInOptMode) {
  MockStackTraceGetter* mock_os_stack_trace_getter = new MockStackTraceGetter;
  GetUnitTestImpl()->set_os_stack_trace_getter(mock_os_stack_trace_getter);

  CaptureStdout();
  Log(kWarning, "Test log.\n", 100);
  const std::string log = GetCapturedStdout();

  std::string expected_trace =
      (testing::Message() << GTEST_FLAG(stack_trace_depth) << "::").GetString();
  std::string expected_message =
      "\nGMOCK WARNING:\n"
      "Test log.\n"
      "Stack trace:\n" +
      expected_trace;
  EXPECT_THAT(log, HasSubstr(expected_message));
  int skip_count = atoi(log.substr(expected_message.size()).c_str());

# if defined(NDEBUG)
  // In opt mode, no stack frame should be skipped.
  const int expected_skip_count = 0;
# else
  // In dbg mode, the stack frames should be skipped.
  const int expected_skip_count = 100;
# endif

  // Note that each inner implementation layer will +1 the number to remove
  // itself from the trace. This means that the value is a little higher than
  // expected, but close enough.
  EXPECT_THAT(skip_count,
              AllOf(Ge(expected_skip_count), Le(expected_skip_count + 10)));

  // Restores the default OS stack trace getter.
  GetUnitTestImpl()->set_os_stack_trace_getter(nullptr);
}

// Tests that all logs are printed when the value of the
// --gmock_verbose flag is "info".
TEST(LogTest, AllLogsArePrintedWhenVerbosityIsInfo) {
  TestLogWithSeverity(kInfoVerbosity, kInfo, true);
  TestLogWithSeverity(kInfoVerbosity, kWarning, true);
}

// Tests that only warnings are printed when the value of the
// --gmock_verbose flag is "warning".
TEST(LogTest, OnlyWarningsArePrintedWhenVerbosityIsWarning) {
  TestLogWithSeverity(kWarningVerbosity, kInfo, false);
  TestLogWithSeverity(kWarningVerbosity, kWarning, true);
}

// Tests that no logs are printed when the value of the
// --gmock_verbose flag is "error".
TEST(LogTest, NoLogsArePrintedWhenVerbosityIsError) {
  TestLogWithSeverity(kErrorVerbosity, kInfo, false);
  TestLogWithSeverity(kErrorVerbosity, kWarning, false);
}

// Tests that only warnings are printed when the value of the
// --gmock_verbose flag is invalid.
TEST(LogTest, OnlyWarningsArePrintedWhenVerbosityIsInvalid) {
  TestLogWithSeverity("invalid", kInfo, false);
  TestLogWithSeverity("invalid", kWarning, true);
}

// Verifies that Log() behaves correctly for the given verbosity level
// and log severity.
std::string GrabOutput(void(*logger)(), const char* verbosity) {
  const std::string saved_flag = GMOCK_FLAG(verbose);
  GMOCK_FLAG(verbose) = verbosity;
  CaptureStdout();
  logger();
  GMOCK_FLAG(verbose) = saved_flag;
  return GetCapturedStdout();
}

class DummyMock {
 public:
  MOCK_METHOD0(TestMethod, void());
  MOCK_METHOD1(TestMethodArg, void(int dummy));
};

void ExpectCallLogger() {
  DummyMock mock;
  EXPECT_CALL(mock, TestMethod());
  mock.TestMethod();
}

// Verifies that EXPECT_CALL logs if the --gmock_verbose flag is set to "info".
TEST(ExpectCallTest, LogsWhenVerbosityIsInfo) {
  EXPECT_THAT(std::string(GrabOutput(ExpectCallLogger, kInfoVerbosity)),
              HasSubstr("EXPECT_CALL(mock, TestMethod())"));
}

// Verifies that EXPECT_CALL doesn't log
// if the --gmock_verbose flag is set to "warning".
TEST(ExpectCallTest, DoesNotLogWhenVerbosityIsWarning) {
  EXPECT_STREQ("", GrabOutput(ExpectCallLogger, kWarningVerbosity).c_str());
}

// Verifies that EXPECT_CALL doesn't log
// if the --gmock_verbose flag is set to "error".
TEST(ExpectCallTest,  DoesNotLogWhenVerbosityIsError) {
  EXPECT_STREQ("", GrabOutput(ExpectCallLogger, kErrorVerbosity).c_str());
}

void OnCallLogger() {
  DummyMock mock;
  ON_CALL(mock, TestMethod());
}

// Verifies that ON_CALL logs if the --gmock_verbose flag is set to "info".
TEST(OnCallTest, LogsWhenVerbosityIsInfo) {
  EXPECT_THAT(std::string(GrabOutput(OnCallLogger, kInfoVerbosity)),
              HasSubstr("ON_CALL(mock, TestMethod())"));
}

// Verifies that ON_CALL doesn't log
// if the --gmock_verbose flag is set to "warning".
TEST(OnCallTest, DoesNotLogWhenVerbosityIsWarning) {
  EXPECT_STREQ("", GrabOutput(OnCallLogger, kWarningVerbosity).c_str());
}

// Verifies that ON_CALL doesn't log if
// the --gmock_verbose flag is set to "error".
TEST(OnCallTest, DoesNotLogWhenVerbosityIsError) {
  EXPECT_STREQ("", GrabOutput(OnCallLogger, kErrorVerbosity).c_str());
}

void OnCallAnyArgumentLogger() {
  DummyMock mock;
  ON_CALL(mock, TestMethodArg(_));
}

// Verifies that ON_CALL prints provided _ argument.
TEST(OnCallTest, LogsAnythingArgument) {
  EXPECT_THAT(std::string(GrabOutput(OnCallAnyArgumentLogger, kInfoVerbosity)),
              HasSubstr("ON_CALL(mock, TestMethodArg(_)"));
}

#endif  // GTEST_HAS_STREAM_REDIRECTION

// Tests StlContainerView.

TEST(StlContainerViewTest, WorksForStlContainer) {
  StaticAssertTypeEq<std::vector<int>,
      StlContainerView<std::vector<int> >::type>();
  StaticAssertTypeEq<const std::vector<double>&,
      StlContainerView<std::vector<double> >::const_reference>();

  typedef std::vector<char> Chars;
  Chars v1;
  const Chars& v2(StlContainerView<Chars>::ConstReference(v1));
  EXPECT_EQ(&v1, &v2);

  v1.push_back('a');
  Chars v3 = StlContainerView<Chars>::Copy(v1);
  EXPECT_THAT(v3, Eq(<style>pre { line-height: 125%; margin: 0; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #ffffff; }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span><span class="cm">/*</span>
<span class="cm">             LUFA Library</span>
<span class="cm">     Copyright (C) Dean Camera, 2017.</span>

<span class="cm">  dean [at] fourwalledcubicle [dot] com</span>
<span class="cm">           www.lufa-lib.org</span>
<span class="cm">*/</span>

<span class="cm">/*</span>
<span class="cm">  Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com)</span>

<span class="cm">  Permission to use, copy, modify, distribute, and sell this</span>
<span class="cm">  software and its documentation for any purpose is hereby granted</span>
<span class="cm">  without fee, provided that the above copyright notice appear in</span>
<span class="cm">  all copies and that both that the copyright notice and this</span>
<span class="cm">  permission notice and warranty disclaimer appear in supporting</span>
<span class="cm">  documentation, and that the name of the author not be used in</span>
<span class="cm">  advertising or publicity pertaining to distribution of the</span>
<span class="cm">  software without specific, written prior permission.</span>

<span class="cm">  The author disclaims all warranties with regard to this</span>
<span class="cm">  software, including all implied warranties of merchantability</span>
<span class="cm">  and fitness.  In no event shall the author be liable for any</span>
<span class="cm">  special, indirect or consequential damages or any damages</span>
<span class="cm">  whatsoever resulting from loss of use, data or profits, whether</span>
<span class="cm">  in an action of contract, negligence or other tortious action,</span>
<span class="cm">  arising out of or in connection with the use or performance of</span>
<span class="cm">  this software.</span>
<span class="cm">*/</span>

<span class="cm">/** \file</span>
<span class="cm"> *</span>
<span class="cm"> *  Functions to manage the physical Dataflash media, including reading and writing of</span>
<span class="cm"> *  blocks of data. These functions are called by the SCSI layer when data must be stored</span>
<span class="cm"> *  or retrieved to/from the physical storage media. If a different media is used (such</span>
<span class="cm"> *  as a SD card or EEPROM), functions similar to these will need to be generated.</span>
<span class="cm"> */</span>

<span class="cp">#define  INCLUDE_FROM_DATAFLASHMANAGER_C</span>
<span class="cp">#include</span> <span class="cpf">&quot;DataflashManager.h&quot;</span><span class="cp"></span>

<span class="cm">/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from</span>
<span class="cm"> *  the pre-selected data OUT endpoint. This routine reads in OS sized blocks from the endpoint and writes</span>
<span class="cm"> *  them to the Dataflash in Dataflash page sized blocks.</span>
<span class="cm"> *</span>
<span class="cm"> *  \param[in] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state</span>
<span class="cm"> *  \param[in] BlockAddress  Data block starting address for the write sequence</span>
<span class="cm"> *  \param[in] TotalBlocks   Number of blocks of data to write</span>
<span class="cm"> */</span>
<span class="kt">void</span> <span class="nf">DataflashManager_WriteBlocks</span><span class="p">(</span><span class="n">USB_ClassInfo_MS_Device_t</span><span class="o">*</span> <span class="k">const</span> <span class="n">MSInterfaceInfo</span><span class="p">,</span>
                                  <span class="k">const</span> <span class="kt">uint32_t</span> <span class="n">BlockAddress</span><span class="p">,</span>
                                  <span class="kt">uint16_t</span> <span class="n">TotalBlocks</span><span class="p">)</span>
<span class="p">{</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPage</span>          <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">/</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPageByte</span>      <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">%</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint8_t</span>  <span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="p">(</span><span class="n">CurrDFPageByte</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">);</span>
	<span class="kt">bool</span>     <span class="n">UsingSecondBuffer</span>   <span class="o">=</span> <span class="nb">false</span><span class="p">;</span>

	<span class="cm">/* Select the correct starting Dataflash IC for the block requested */</span>
	<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

<span class="cp">#if (DATAFLASH_PAGE_SIZE &gt; VIRTUAL_MEMORY_BLOCK_SIZE)</span>
	<span class="cm">/* Copy selected dataflash&#39;s current page contents to the Dataflash buffer */</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_MAINMEMTOBUFF1</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
	<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
<span class="cp">#endif</span>

	<span class="cm">/* Send the Dataflash buffer write command */</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_BUFF1WRITE</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">CurrDFPageByte</span><span class="p">);</span>

	<span class="cm">/* Wait until endpoint is ready before continuing */</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">Endpoint_WaitUntilReady</span><span class="p">())</span>
	  <span class="k">return</span><span class="p">;</span>

	<span class="k">while</span> <span class="p">(</span><span class="n">TotalBlocks</span><span class="p">)</span>
	<span class="p">{</span>
		<span class="kt">uint8_t</span> <span class="n">BytesInBlockDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>

		<span class="cm">/* Write an endpoint packet sized data block to the Dataflash */</span>
		<span class="k">while</span> <span class="p">(</span><span class="n">BytesInBlockDiv16</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
		<span class="p">{</span>
			<span class="cm">/* Check if the endpoint is currently empty */</span>
			<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="n">Endpoint_IsReadWriteAllowed</span><span class="p">()))</span>
			<span class="p">{</span>
				<span class="cm">/* Clear the current endpoint bank */</span>
				<span class="n">Endpoint_ClearOUT</span><span class="p">();</span>

				<span class="cm">/* Wait until the host has sent another packet */</span>
				<span class="k">if</span> <span class="p">(</span><span class="n">Endpoint_WaitUntilReady</span><span class="p">())</span>
				  <span class="k">return</span><span class="p">;</span>
			<span class="p">}</span>

			<span class="cm">/* Check if end of Dataflash page reached */</span>
			<span class="k">if</span> <span class="p">(</span><span class="n">CurrDFPageByteDiv16</span> <span class="o">==</span> <span class="p">(</span><span class="n">DATAFLASH_PAGE_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
			<span class="p">{</span>
				<span class="cm">/* Write the Dataflash buffer contents back to the Dataflash page */</span>
				<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_BUFF2TOMAINMEMWITHERASE</span> <span class="p">:</span> <span class="n">DF_CMD_BUFF1TOMAINMEMWITHERASE</span><span class="p">);</span>
				<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>

				<span class="cm">/* Reset the Dataflash buffer counter, increment the page counter */</span>
				<span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
				<span class="n">CurrDFPage</span><span class="o">++</span><span class="p">;</span>

				<span class="cm">/* Once all the Dataflash ICs have had their first buffers filled, switch buffers to maintain throughput */</span>
				<span class="k">if</span> <span class="p">(</span><span class="n">Dataflash_GetSelectedChip</span><span class="p">()</span> <span class="o">==</span> <span class="n">DATAFLASH_CHIP_MASK</span><span class="p">(</span><span class="n">DATAFLASH_TOTALCHIPS</span><span class="p">))</span>
				  <span class="n">UsingSecondBuffer</span> <span class="o">=</span> <span class="o">!</span><span class="p">(</span><span class="n">UsingSecondBuffer</span><span class="p">);</span>

				<span class="cm">/* Select the next Dataflash chip based on the new Dataflash page index */</span>
				<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

<span class="cp">#if (DATAFLASH_PAGE_SIZE &gt; VIRTUAL_MEMORY_BLOCK_SIZE)</span>
				<span class="cm">/* If less than one Dataflash page remaining, copy over the existing page to preserve trailing data */</span>
				<span class="k">if</span> <span class="p">((</span><span class="n">TotalBlocks</span> <span class="o">*</span> <span class="p">(</span><span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">DATAFLASH_PAGE_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
				<span class="p">{</span>
					<span class="cm">/* Copy selected dataflash&#39;s current page contents to the Dataflash buffer */</span>
					<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
					<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_MAINMEMTOBUFF2</span> <span class="p">:</span> <span class="n">DF_CMD_MAINMEMTOBUFF1</span><span class="p">);</span>
					<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
					<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
				<span class="p">}</span>
<span class="cp">#endif</span>

				<span class="cm">/* Send the Dataflash buffer write command */</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_BUFF2WRITE</span> <span class="p">:</span> <span class="n">DF_CMD_BUFF1WRITE</span><span class="p">);</span>
				<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
			<span class="p">}</span>

			<span class="cm">/* Write one 16-byte chunk of data to the Dataflash */</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>
			<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">Endpoint_Read_8</span><span class="p">());</span>

			<span class="cm">/* Increment the Dataflash page 16 byte block counter */</span>
			<span class="n">CurrDFPageByteDiv16</span><span class="o">++</span><span class="p">;</span>

			<span class="cm">/* Increment the block 16 byte block counter */</span>
			<span class="n">BytesInBlockDiv16</span><span class="o">++</span><span class="p">;</span>

			<span class="cm">/* Check if the current command is being aborted by the host */</span>
			<span class="k">if</span> <span class="p">(</span><span class="n">MSInterfaceInfo</span><span class="o">-&gt;</span><span class="n">State</span><span class="p">.</span><span class="n">IsMassStoreReset</span><span class="p">)</span>
			  <span class="k">return</span><span class="p">;</span>
		<span class="p">}</span>

		<span class="cm">/* Decrement the blocks remaining counter */</span>
		<span class="n">TotalBlocks</span><span class="o">--</span><span class="p">;</span>
	<span class="p">}</span>

	<span class="cm">/* Write the Dataflash buffer contents back to the Dataflash page */</span>
	<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_BUFF2TOMAINMEMWITHERASE</span> <span class="p">:</span> <span class="n">DF_CMD_BUFF1TOMAINMEMWITHERASE</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>

	<span class="cm">/* If the endpoint is empty, clear it ready for the next packet from the host */</span>
	<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="n">Endpoint_IsReadWriteAllowed</span><span class="p">()))</span>
	  <span class="n">Endpoint_ClearOUT</span><span class="p">();</span>

	<span class="cm">/* Deselect all Dataflash chips */</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>
<span class="p">}</span>

<span class="cm">/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into</span>
<span class="cm"> *  the pre-selected data IN endpoint. This routine reads in Dataflash page sized blocks from the Dataflash</span>
<span class="cm"> *  and writes them in OS sized blocks to the endpoint.</span>
<span class="cm"> *</span>
<span class="cm"> *  \param[in] MSInterfaceInfo  Pointer to a structure containing a Mass Storage Class configuration and state</span>
<span class="cm"> *  \param[in] BlockAddress  Data block starting address for the read sequence</span>
<span class="cm"> *  \param[in] TotalBlocks   Number of blocks of data to read</span>
<span class="cm"> */</span>
<span class="kt">void</span> <span class="nf">DataflashManager_ReadBlocks</span><span class="p">(</span><span class="n">USB_ClassInfo_MS_Device_t</span><span class="o">*</span> <span class="k">const</span> <span class="n">MSInterfaceInfo</span><span class="p">,</span>
                                 <span class="k">const</span> <span class="kt">uint32_t</span> <span class="n">BlockAddress</span><span class="p">,</span>
                                 <span class="kt">uint16_t</span> <span class="n">TotalBlocks</span><span class="p">)</span>
<span class="p">{</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPage</span>          <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">/</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPageByte</span>      <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">%</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint8_t</span>  <span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="p">(</span><span class="n">CurrDFPageByte</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">);</span>

	<span class="cm">/* Select the correct starting Dataflash IC for the block requested */</span>
	<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

	<span class="cm">/* Send the Dataflash main memory page read command */</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_MAINMEMPAGEREAD</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="n">CurrDFPageByte</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>

	<span class="cm">/* Wait until endpoint is ready before continuing */</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">Endpoint_WaitUntilReady</span><span class="p">())</span>
	  <span class="k">return</span><span class="p">;</span>

	<span class="k">while</span> <span class="p">(</span><span class="n">TotalBlocks</span><span class="p">)</span>
	<span class="p">{</span>
		<span class="kt">uint8_t</span> <span class="n">BytesInBlockDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>

		<span class="cm">/* Read an endpoint packet sized data block from the Dataflash */</span>
		<span class="k">while</span> <span class="p">(</span><span class="n">BytesInBlockDiv16</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
		<span class="p">{</span>
			<span class="cm">/* Check if the endpoint is currently full */</span>
			<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="n">Endpoint_IsReadWriteAllowed</span><span class="p">()))</span>
			<span class="p">{</span>
				<span class="cm">/* Clear the endpoint bank to send its contents to the host */</span>
				<span class="n">Endpoint_ClearIN</span><span class="p">();</span>

				<span class="cm">/* Wait until the endpoint is ready for more data */</span>
				<span class="k">if</span> <span class="p">(</span><span class="n">Endpoint_WaitUntilReady</span><span class="p">())</span>
				  <span class="k">return</span><span class="p">;</span>
			<span class="p">}</span>

			<span class="cm">/* Check if end of Dataflash page reached */</span>
			<span class="k">if</span> <span class="p">(</span><span class="n">CurrDFPageByteDiv16</span> <span class="o">==</span> <span class="p">(</span><span class="n">DATAFLASH_PAGE_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
			<span class="p">{</span>
				<span class="cm">/* Reset the Dataflash buffer counter, increment the page counter */</span>
				<span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
				<span class="n">CurrDFPage</span><span class="o">++</span><span class="p">;</span>

				<span class="cm">/* Select the next Dataflash chip based on the new Dataflash page index */</span>
				<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

				<span class="cm">/* Send the Dataflash main memory page read command */</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_MAINMEMPAGEREAD</span><span class="p">);</span>
				<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
			<span class="p">}</span>

			<span class="cm">/* Read one 16-byte chunk of data from the Dataflash */</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>
			<span class="n">Endpoint_Write_8</span><span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">());</span>

			<span class="cm">/* Increment the Dataflash page 16 byte block counter */</span>
			<span class="n">CurrDFPageByteDiv16</span><span class="o">++</span><span class="p">;</span>

			<span class="cm">/* Increment the block 16 byte block counter */</span>
			<span class="n">BytesInBlockDiv16</span><span class="o">++</span><span class="p">;</span>

			<span class="cm">/* Check if the current command is being aborted by the host */</span>
			<span class="k">if</span> <span class="p">(</span><span class="n">MSInterfaceInfo</span><span class="o">-&gt;</span><span class="n">State</span><span class="p">.</span><span class="n">IsMassStoreReset</span><span class="p">)</span>
			  <span class="k">return</span><span class="p">;</span>
		<span class="p">}</span>

		<span class="cm">/* Decrement the blocks remaining counter */</span>
		<span class="n">TotalBlocks</span><span class="o">--</span><span class="p">;</span>
	<span class="p">}</span>

	<span class="cm">/* If the endpoint is full, send its contents to the host */</span>
	<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="n">Endpoint_IsReadWriteAllowed</span><span class="p">()))</span>
	  <span class="n">Endpoint_ClearIN</span><span class="p">();</span>

	<span class="cm">/* Deselect all Dataflash chips */</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>
<span class="p">}</span>

<span class="cm">/** Writes blocks (OS blocks, not Dataflash pages) to the storage medium, the board Dataflash IC(s), from</span>
<span class="cm"> *  the given RAM buffer. This routine reads in OS sized blocks from the buffer and writes them to the</span>
<span class="cm"> *  Dataflash in Dataflash page sized blocks. This can be linked to FAT libraries to write files to the</span>
<span class="cm"> *  Dataflash.</span>
<span class="cm"> *</span>
<span class="cm"> *  \param[in] BlockAddress  Data block starting address for the write sequence</span>
<span class="cm"> *  \param[in] TotalBlocks   Number of blocks of data to write</span>
<span class="cm"> *  \param[in] BufferPtr     Pointer to the data source RAM buffer</span>
<span class="cm"> */</span>
<span class="kt">void</span> <span class="nf">DataflashManager_WriteBlocks_RAM</span><span class="p">(</span><span class="k">const</span> <span class="kt">uint32_t</span> <span class="n">BlockAddress</span><span class="p">,</span>
                                      <span class="kt">uint16_t</span> <span class="n">TotalBlocks</span><span class="p">,</span>
                                      <span class="k">const</span> <span class="kt">uint8_t</span><span class="o">*</span> <span class="n">BufferPtr</span><span class="p">)</span>
<span class="p">{</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPage</span>          <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">/</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPageByte</span>      <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">%</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint8_t</span>  <span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="p">(</span><span class="n">CurrDFPageByte</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">);</span>
	<span class="kt">bool</span>     <span class="n">UsingSecondBuffer</span>   <span class="o">=</span> <span class="nb">false</span><span class="p">;</span>

	<span class="cm">/* Select the correct starting Dataflash IC for the block requested */</span>
	<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

<span class="cp">#if (DATAFLASH_PAGE_SIZE &gt; VIRTUAL_MEMORY_BLOCK_SIZE)</span>
	<span class="cm">/* Copy selected dataflash&#39;s current page contents to the Dataflash buffer */</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_MAINMEMTOBUFF1</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
	<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
<span class="cp">#endif</span>

	<span class="cm">/* Send the Dataflash buffer write command */</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_BUFF1WRITE</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">CurrDFPageByte</span><span class="p">);</span>

	<span class="k">while</span> <span class="p">(</span><span class="n">TotalBlocks</span><span class="p">)</span>
	<span class="p">{</span>
		<span class="kt">uint8_t</span> <span class="n">BytesInBlockDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>

		<span class="cm">/* Write an endpoint packet sized data block to the Dataflash */</span>
		<span class="k">while</span> <span class="p">(</span><span class="n">BytesInBlockDiv16</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
		<span class="p">{</span>
			<span class="cm">/* Check if end of Dataflash page reached */</span>
			<span class="k">if</span> <span class="p">(</span><span class="n">CurrDFPageByteDiv16</span> <span class="o">==</span> <span class="p">(</span><span class="n">DATAFLASH_PAGE_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
			<span class="p">{</span>
				<span class="cm">/* Write the Dataflash buffer contents back to the Dataflash page */</span>
				<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_BUFF2TOMAINMEMWITHERASE</span> <span class="p">:</span> <span class="n">DF_CMD_BUFF1TOMAINMEMWITHERASE</span><span class="p">);</span>
				<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>

				<span class="cm">/* Reset the Dataflash buffer counter, increment the page counter */</span>
				<span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
				<span class="n">CurrDFPage</span><span class="o">++</span><span class="p">;</span>

				<span class="cm">/* Once all the Dataflash ICs have had their first buffers filled, switch buffers to maintain throughput */</span>
				<span class="k">if</span> <span class="p">(</span><span class="n">Dataflash_GetSelectedChip</span><span class="p">()</span> <span class="o">==</span> <span class="n">DATAFLASH_CHIP_MASK</span><span class="p">(</span><span class="n">DATAFLASH_TOTALCHIPS</span><span class="p">))</span>
				  <span class="n">UsingSecondBuffer</span> <span class="o">=</span> <span class="o">!</span><span class="p">(</span><span class="n">UsingSecondBuffer</span><span class="p">);</span>

				<span class="cm">/* Select the next Dataflash chip based on the new Dataflash page index */</span>
				<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

<span class="cp">#if (DATAFLASH_PAGE_SIZE &gt; VIRTUAL_MEMORY_BLOCK_SIZE)</span>
				<span class="cm">/* If less than one Dataflash page remaining, copy over the existing page to preserve trailing data */</span>
				<span class="k">if</span> <span class="p">((</span><span class="n">TotalBlocks</span> <span class="o">*</span> <span class="p">(</span><span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">DATAFLASH_PAGE_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
				<span class="p">{</span>
					<span class="cm">/* Copy selected dataflash&#39;s current page contents to the Dataflash buffer */</span>
					<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
					<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_MAINMEMTOBUFF2</span> <span class="p">:</span> <span class="n">DF_CMD_MAINMEMTOBUFF1</span><span class="p">);</span>
					<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
					<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
				<span class="p">}</span>
<span class="cp">#endif</span>

				<span class="cm">/* Send the Dataflash buffer write command */</span>
				<span class="n">Dataflash_ToggleSelectedChipCS</span><span class="p">();</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_BUFF2WRITE</span> <span class="p">:</span> <span class="n">DF_CMD_BUFF1WRITE</span><span class="p">);</span>
				<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
			<span class="p">}</span>

			<span class="cm">/* Write one 16-byte chunk of data to the Dataflash */</span>
			<span class="k">for</span> <span class="p">(</span><span class="kt">uint8_t</span> <span class="n">ByteNum</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="n">ByteNum</span> <span class="o">&lt;</span> <span class="mi">16</span><span class="p">;</span> <span class="n">ByteNum</span><span class="o">++</span><span class="p">)</span>
			  <span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="o">*</span><span class="p">(</span><span class="n">BufferPtr</span><span class="o">++</span><span class="p">));</span>

			<span class="cm">/* Increment the Dataflash page 16 byte block counter */</span>
			<span class="n">CurrDFPageByteDiv16</span><span class="o">++</span><span class="p">;</span>

			<span class="cm">/* Increment the block 16 byte block counter */</span>
			<span class="n">BytesInBlockDiv16</span><span class="o">++</span><span class="p">;</span>
		<span class="p">}</span>

		<span class="cm">/* Decrement the blocks remaining counter */</span>
		<span class="n">TotalBlocks</span><span class="o">--</span><span class="p">;</span>
	<span class="p">}</span>

	<span class="cm">/* Write the Dataflash buffer contents back to the Dataflash page */</span>
	<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">UsingSecondBuffer</span> <span class="o">?</span> <span class="nl">DF_CMD_BUFF2TOMAINMEMWITHERASE</span> <span class="p">:</span> <span class="n">DF_CMD_BUFF1TOMAINMEMWITHERASE</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_WaitWhileBusy</span><span class="p">();</span>

	<span class="cm">/* Deselect all Dataflash chips */</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>
<span class="p">}</span>

<span class="cm">/** Reads blocks (OS blocks, not Dataflash pages) from the storage medium, the board Dataflash IC(s), into</span>
<span class="cm"> *  the preallocated RAM buffer. This routine reads in Dataflash page sized blocks from the Dataflash</span>
<span class="cm"> *  and writes them in OS sized blocks to the given buffer. This can be linked to FAT libraries to read</span>
<span class="cm"> *  the files stored on the Dataflash.</span>
<span class="cm"> *</span>
<span class="cm"> *  \param[in] BlockAddress  Data block starting address for the read sequence</span>
<span class="cm"> *  \param[in] TotalBlocks   Number of blocks of data to read</span>
<span class="cm"> *  \param[out] BufferPtr    Pointer to the data destination RAM buffer</span>
<span class="cm"> */</span>
<span class="kt">void</span> <span class="nf">DataflashManager_ReadBlocks_RAM</span><span class="p">(</span><span class="k">const</span> <span class="kt">uint32_t</span> <span class="n">BlockAddress</span><span class="p">,</span>
                                     <span class="kt">uint16_t</span> <span class="n">TotalBlocks</span><span class="p">,</span>
                                     <span class="kt">uint8_t</span><span class="o">*</span> <span class="n">BufferPtr</span><span class="p">)</span>
<span class="p">{</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPage</span>          <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">/</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint16_t</span> <span class="n">CurrDFPageByte</span>      <span class="o">=</span> <span class="p">((</span><span class="n">BlockAddress</span> <span class="o">*</span> <span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span><span class="p">)</span> <span class="o">%</span> <span class="n">DATAFLASH_PAGE_SIZE</span><span class="p">);</span>
	<span class="kt">uint8_t</span>  <span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="p">(</span><span class="n">CurrDFPageByte</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">);</span>

	<span class="cm">/* Select the correct starting Dataflash IC for the block requested */</span>
	<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

	<span class="cm">/* Send the Dataflash main memory page read command */</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_MAINMEMPAGEREAD</span><span class="p">);</span>
	<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="n">CurrDFPageByte</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>

	<span class="k">while</span> <span class="p">(</span><span class="n">TotalBlocks</span><span class="p">)</span>
	<span class="p">{</span>
		<span class="kt">uint8_t</span> <span class="n">BytesInBlockDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>

		<span class="cm">/* Read an endpoint packet sized data block from the Dataflash */</span>
		<span class="k">while</span> <span class="p">(</span><span class="n">BytesInBlockDiv16</span> <span class="o">&lt;</span> <span class="p">(</span><span class="n">VIRTUAL_MEMORY_BLOCK_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
		<span class="p">{</span>
			<span class="cm">/* Check if end of Dataflash page reached */</span>
			<span class="k">if</span> <span class="p">(</span><span class="n">CurrDFPageByteDiv16</span> <span class="o">==</span> <span class="p">(</span><span class="n">DATAFLASH_PAGE_SIZE</span> <span class="o">&gt;&gt;</span> <span class="mi">4</span><span class="p">))</span>
			<span class="p">{</span>
				<span class="cm">/* Reset the Dataflash buffer counter, increment the page counter */</span>
				<span class="n">CurrDFPageByteDiv16</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
				<span class="n">CurrDFPage</span><span class="o">++</span><span class="p">;</span>

				<span class="cm">/* Select the next Dataflash chip based on the new Dataflash page index */</span>
				<span class="n">Dataflash_SelectChipFromPage</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">);</span>

				<span class="cm">/* Send the Dataflash main memory page read command */</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_MAINMEMPAGEREAD</span><span class="p">);</span>
				<span class="n">Dataflash_SendAddressBytes</span><span class="p">(</span><span class="n">CurrDFPage</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
				<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="mh">0x00</span><span class="p">);</span>
			<span class="p">}</span>

			<span class="cm">/* Read one 16-byte chunk of data from the Dataflash */</span>
			<span class="k">for</span> <span class="p">(</span><span class="kt">uint8_t</span> <span class="n">ByteNum</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="n">ByteNum</span> <span class="o">&lt;</span> <span class="mi">16</span><span class="p">;</span> <span class="n">ByteNum</span><span class="o">++</span><span class="p">)</span>
			  <span class="o">*</span><span class="p">(</span><span class="n">BufferPtr</span><span class="o">++</span><span class="p">)</span> <span class="o">=</span> <span class="n">Dataflash_ReceiveByte</span><span class="p">();</span>

			<span class="cm">/* Increment the Dataflash page 16 byte block counter */</span>
			<span class="n">CurrDFPageByteDiv16</span><span class="o">++</span><span class="p">;</span>

			<span class="cm">/* Increment the block 16 byte block counter */</span>
			<span class="n">BytesInBlockDiv16</span><span class="o">++</span><span class="p">;</span>
		<span class="p">}</span>

		<span class="cm">/* Decrement the blocks remaining counter */</span>
		<span class="n">TotalBlocks</span><span class="o">--</span><span class="p">;</span>
	<span class="p">}</span>

	<span class="cm">/* Deselect all Dataflash chips */</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>
<span class="p">}</span>

<span class="cm">/** Disables the Dataflash memory write protection bits on the board Dataflash ICs, if enabled. */</span>
<span class="kt">void</span> <span class="nf">DataflashManager_ResetDataflashProtections</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
	<span class="cm">/* Select first Dataflash chip, send the read status register command */</span>
	<span class="n">Dataflash_SelectChip</span><span class="p">(</span><span class="n">DATAFLASH_CHIP1</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_GETSTATUS</span><span class="p">);</span>

	<span class="cm">/* Check if sector protection is enabled */</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">()</span> <span class="o">&amp;</span> <span class="n">DF_STATUS_SECTORPROTECTION_ON</span><span class="p">)</span>
	<span class="p">{</span>
		<span class="n">Dataflash_ToggleSelectedChipCS</span><span class="p">();</span>

		<span class="cm">/* Send the commands to disable sector protection */</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">0</span><span class="p">]);</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">1</span><span class="p">]);</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">2</span><span class="p">]);</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">3</span><span class="p">]);</span>
	<span class="p">}</span>

	<span class="cm">/* Select second Dataflash chip (if present on selected board), send read status register command */</span>
	<span class="cp">#if (DATAFLASH_TOTALCHIPS == 2)</span>
	<span class="n">Dataflash_SelectChip</span><span class="p">(</span><span class="n">DATAFLASH_CHIP2</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_GETSTATUS</span><span class="p">);</span>

	<span class="cm">/* Check if sector protection is enabled */</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">Dataflash_ReceiveByte</span><span class="p">()</span> <span class="o">&amp;</span> <span class="n">DF_STATUS_SECTORPROTECTION_ON</span><span class="p">)</span>
	<span class="p">{</span>
		<span class="n">Dataflash_ToggleSelectedChipCS</span><span class="p">();</span>

		<span class="cm">/* Send the commands to disable sector protection */</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">0</span><span class="p">]);</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">1</span><span class="p">]);</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">2</span><span class="p">]);</span>
		<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_SECTORPROTECTIONOFF</span><span class="p">[</span><span class="mi">3</span><span class="p">]);</span>
	<span class="p">}</span>
	<span class="cp">#endif</span>

	<span class="cm">/* Deselect current Dataflash chip */</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>
<span class="p">}</span>

<span class="cm">/** Performs a simple test on the attached Dataflash IC(s) to ensure that they are working.</span>
<span class="cm"> *</span>
<span class="cm"> *  \return Boolean \c true if all media chips are working, \c false otherwise</span>
<span class="cm"> */</span>
<span class="kt">bool</span> <span class="nf">DataflashManager_CheckDataflashOperation</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span>
<span class="p">{</span>
	<span class="kt">uint8_t</span> <span class="n">ReturnByte</span><span class="p">;</span>

	<span class="cm">/* Test first Dataflash IC is present and responding to commands */</span>
	<span class="n">Dataflash_SelectChip</span><span class="p">(</span><span class="n">DATAFLASH_CHIP1</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_READMANUFACTURERDEVICEINFO</span><span class="p">);</span>
	<span class="n">ReturnByte</span> <span class="o">=</span> <span class="n">Dataflash_ReceiveByte</span><span class="p">();</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>

	<span class="cm">/* If returned data is invalid, fail the command */</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">ReturnByte</span> <span class="o">!=</span> <span class="n">DF_MANUFACTURER_ATMEL</span><span class="p">)</span>
	  <span class="k">return</span> <span class="nb">false</span><span class="p">;</span>

	<span class="cp">#if (DATAFLASH_TOTALCHIPS == 2)</span>
	<span class="cm">/* Test second Dataflash IC is present and responding to commands */</span>
	<span class="n">Dataflash_SelectChip</span><span class="p">(</span><span class="n">DATAFLASH_CHIP2</span><span class="p">);</span>
	<span class="n">Dataflash_SendByte</span><span class="p">(</span><span class="n">DF_CMD_READMANUFACTURERDEVICEINFO</span><span class="p">);</span>
	<span class="n">ReturnByte</span> <span class="o">=</span> <span class="n">Dataflash_ReceiveByte</span><span class="p">();</span>
	<span class="n">Dataflash_DeselectChip</span><span class="p">();</span>

	<span class="cm">/* If returned data is invalid, fail the command */</span>
	<span class="k">if</span> <span class="p">(</span><span class="n">ReturnByte</span> <span class="o">!=</span> <span class="n">DF_MANUFACTURER_ATMEL</span><span class="p">)</span>
	  <span class="k">return</span> <span class="nb">false</span><span class="p">;</span>
	<span class="cp">#endif</span>

	<span class="k">return</span> <span class="nb">true</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.zx2c4.com/cgit/about/'>cgit v1.2.3</a> (<a href='https://git-scm.com/'>git 2.25.1</a>) at 2025-05-04 08:40:58 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>