Kinetis Bootloader  2.0.0
Common bootloader for Kinetis devices
host_hardware.h
1 /*
2  * Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * o Redistributions of source code must retain the above copyright notice, this list
9  * of conditions and the following disclaimer.
10  *
11  * o Redistributions in binary form must reproduce the above copyright notice, this
12  * list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from this
17  * software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #if !defined(__HOST_HARDWARE_H__)
31 #define __HOST_HARDWARE_H__
32 
33 #include "bootloader_common.h"
34 #include "microseconds/microseconds.h"
35 #include "dspi/fsl_dspi.h"
36 
37 /*******************************************************************************
38  * Definitions
39  ******************************************************************************/
40 
41 #define UART_INSTANCE 4
42 #define SPI_INSTANCE 2
43 #define I2C_INSTANCE 0
44 #define FLEXCAN_INSTANCE 0
45 
47 enum _uart_baud_value
48 {
49  kUART_MIN_BAUD = 19200,
50  kUART_MAX_BAUD = 230400,
51  kUART_DEFAULT_BAUD = 57600
52 };
53 
55 enum _flexcan_freq_value
56 {
57  kFLEXCAN_125K = 125,
58  kFLEXCAN_250K = 250,
59  kFLEXCAN_500K = 500,
60  kFLEXCAN_750K = 750,
61  kFLEXCAN_1000K = 1000,
62 };
63 
64 /*******************************************************************************
65  * API
66  ******************************************************************************/
67 #if defined(__cplusplus)
68 extern "C" {
69 #endif /* __cplusplus */
70 
72 void hardware_init(void);
73 
75 bool wait_uart_char(uint8_t *data);
76 uint8_t wait_uart_char_blocking(void);
77 
79 void configure_spi_speed(uint32_t speedkhz);
80 
82 status_t receive_spi_data(uint8_t *dest, uint32_t readLength);
83 
85 status_t send_spi_data(uint8_t *src, uint32_t writeLength);
86 
88 void configure_i2c_speed(uint32_t speedkhz);
89 
91 status_t send_i2c_data(uint8_t *src, uint32_t writeLength);
92 
94 status_t receive_i2c_data(uint8_t *dest, uint32_t readLength);
95 
97 void configure_uart_speed(uint32_t baud);
98 
100 status_t send_uart_data(uint8_t *src, uint32_t writeLength);
101 
103 status_t receive_uart_data(uint8_t *dest, uint32_t readLength);
104 
106 void configure_can_speed(uint32_t speed);
107 
109 status_t send_can_data(uint8_t *src, uint32_t writeLength);
110 
112 status_t receive_can_data(uint8_t *dest, uint32_t readLength);
113 
114 #if defined(__cplusplus)
115 }
116 #endif /* __cplusplus */
117 
118 #endif /* __HOST_HARDWARE_H__ */
int32_t status_t
Type used for all status and error return values.
Definition: fsl_common.h:121