Add KBOOT.

src/autobaud/autobaud.h

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2013, Freescale Semiconductor, 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:
+ *
+ * o Redistributions of source code must retain the above copyright notice, this list
+ *   of conditions and the following disclaimer.
+ *
+ * o 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.
+ *
+ * o Neither the name of Freescale Semiconductor, 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 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 _autobaud_h
+#define _autobaud_h
+
+#include "bootloader_common.h"
+#include "bootloader_config.h"
+
+//! @addtogroup autobaud
+//! @{
+
+////////////////////////////////////////////////////////////////////////////////
+// API
+////////////////////////////////////////////////////////////////////////////////
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+//! @name Autobaud
+//@{
+
+//! @brief If completed sets the rate after calculation as 9600, 19200, etc.
+//         If not yet completed returns failure
+//!
+//! @retval #kStatus_Success The baud rate has been calculated successfully.
+//! @retval #kStatus_Fail Not enough edges have been received yet to determine the baud rate.
+status_t autobaud_get_rate(uint32_t instance, uint32_t *rate);
+
+//! @brief Initializes autobaud detection
+void autobaud_init(uint32_t instance);
+
+#if BL_FEATURE_UART_AUTOBAUD_IRQ
+//! @brief De-initializes autobaud detection
+void autobaud_deinit(uint32_t instance);
+#endif
+
+//@}
+
+#if defined(__cplusplus)
+}
+#endif
+
+//! @}
+
+#endif // _autobaud_h
+////////////////////////////////////////////////////////////////////////////////
+// EOF
+////////////////////////////////////////////////////////////////////////////////

src/autobaud/src/autobaud_irq.c

@@ -0,0 +1,170 @@
+/*
+ * Copyright (c) 2013, Freescale Semiconductor, 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:
+ *
+ * o Redistributions of source code must retain the above copyright notice, this list
+ *   of conditions and the following disclaimer.
+ *
+ * o 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.
+ *
+ * o Neither the name of Freescale Semiconductor, 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 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.
+ */
+
+#include "fsl_device_registers.h"
+#include "autobaud/autobaud.h"
+#include "microseconds/microseconds.h"
+#include "bootloader_common.h"
+
+////////////////////////////////////////////////////////////////////////////////
+// Definitions
+////////////////////////////////////////////////////////////////////////////////
+
+enum _autobaud_counts
+{
+    //! the number of falling edge transitions being counted
+    //! for 0x5A
+    kFirstByteRequiredFallingEdges = 4,
+    //! the number of falling edge transitions being counted
+    //! for 0xA6
+    kSecondByteRequiredFallingEdges = 3,
+    //! the number of bits being measured for the baud rate
+    //! for 0x5A we have the start bit + 7 bits to the last falling edge = 8 bits
+    kNumberOfBitsForFirstByteMeasured = 8,
+    //! for 0xA6 we have the start bit + 6 bits to the last falling edge = 7 bits
+    kNumberOfBitsForSecondByteMeasured = 7,
+    //! Time in microseconds that we will wait in between toggles before restarting detection
+    //! Make this value 8 bits at 100 baud worth of time = 80000 microseconds
+    kMaximumTimeBetweenFallingEdges = 80000,
+    //! Autobaud baud step size that our calculation will be rounded to, this is to ensure
+    //! that we can use a valid multiplier in the UART configuration which runs into problems
+    //! at higher baud rates with slightly off baud rates (e.g. if we measure 115458 vs 115200)
+    //! a calculation of UartClock at 48MHz gives an SBR calculation of 48000000/ (16 * 115458) = 25
+    //! giving a baud rate calculation of 48000000/(16 * 25) = 120000 baud
+    //! which is out of spec and fails
+    kAutobaudStepSize = 1200
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// Prototypes
+////////////////////////////////////////////////////////////////////////////////
+void instance_transition_callback(uint32_t instance);
+
+////////////////////////////////////////////////////////////////////////////////
+// Variables
+////////////////////////////////////////////////////////////////////////////////
+
+static uint32_t s_transitionCount;
+static uint64_t s_firstByteTotalTicks;
+static uint64_t s_secondByteTotalTicks;
+static uint64_t s_lastToggleTicks;
+static uint64_t s_ticksBetweenFailure;
+static uint32_t s_instanceMeasured;
+
+////////////////////////////////////////////////////////////////////////////////
+// Code
+////////////////////////////////////////////////////////////////////////////////
+
+void autobaud_init(uint32_t instance)
+{
+    s_transitionCount = 0;
+    s_firstByteTotalTicks = 0;
+    s_secondByteTotalTicks = 0;
+    s_lastToggleTicks = 0;
+    s_instanceMeasured = 0;
+    s_ticksBetweenFailure = microseconds_convert_to_ticks(kMaximumTimeBetweenFallingEdges);
+    enable_autobaud_pin_irq(instance, instance_transition_callback);
+}
+
+void autobaud_deinit(uint32_t instance)
+{
+    disable_autobaud_pin_irq(instance);
+}
+
+status_t autobaud_get_rate(uint32_t instance, uint32_t *rate)
+{
+    if ((s_transitionCount == (kFirstByteRequiredFallingEdges + kSecondByteRequiredFallingEdges)) &&
+        (instance == s_instanceMeasured))
+    {
+        uint32_t calculatedBaud =
+            (microseconds_get_clock() * (kNumberOfBitsForFirstByteMeasured + kNumberOfBitsForSecondByteMeasured)) /
+            (uint32_t)(s_firstByteTotalTicks + s_secondByteTotalTicks);
+
+        // Round the rate to the nearest step size
+        // rounded = stepSize * (value/stepSize + .5)
+        // multiplying by 10 since we can't work with floats
+        *rate = ((((calculatedBaud * 10) / kAutobaudStepSize) + 5) / 10) * kAutobaudStepSize;
+
+        return kStatus_Success;
+    }
+    else
+    {
+        // no baud rate yet/inactive
+        return kStatus_Fail;
+    }
+}
+
+void instance_transition_callback(uint32_t instance)
+{
+    uint64_t ticks = microseconds_get_ticks();
+    s_transitionCount++;
+
+    uint64_t delta = ticks - s_lastToggleTicks;
+
+    // The last toggle was longer than we allow so treat this as the first one
+    if (delta > s_ticksBetweenFailure)
+    {
+        s_transitionCount = 1;
+    }
+
+    switch (s_transitionCount)
+    {
+        case 1:
+            // This is our first falling edge, store the initial ticks temporarily in firstByteTicks
+            // and save the instance that we are measuring
+            s_firstByteTotalTicks = ticks;
+            s_instanceMeasured = instance;
+            break;
+
+        case kFirstByteRequiredFallingEdges:
+            // We reached the end of our measurable first byte, subtract the current ticks from the initial
+            // first byte ticks
+            s_firstByteTotalTicks = ticks - s_firstByteTotalTicks;
+            break;
+
+        case (kFirstByteRequiredFallingEdges + 1):
+            // We hit our first falling edge of the second byte, store the initial ticks temporarily in secondByteTicks
+            s_secondByteTotalTicks = ticks;
+            break;
+
+        case (kFirstByteRequiredFallingEdges + kSecondByteRequiredFallingEdges):
+            // We reached the end of our measurable second byte, subtract the current ticks from the initial
+            // second byte ticks
+            s_secondByteTotalTicks = ticks - s_secondByteTotalTicks;
+            disable_autobaud_pin_irq(instance);
+            break;
+    }
+
+    s_lastToggleTicks = ticks;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// EOF
+////////////////////////////////////////////////////////////////////////////////