Kinetis Bootloader Host  2.0.0
Host Tools for Kinetis devices
BusPalPeripheral.h
1 /*
2  * Copyright (c) 2013-14, 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 
31 #ifndef _BusPalPeripheral_h_
32 #define _BusPalPeripheral_h_
33 
34 #include "UartPeripheral.h"
35 #include "BusPal.h"
36 
39 
40 namespace blfwk
41 {
46 {
47 public:
56  BusPalUartPeripheral(const char *port, long speed, const BusPal::BusPalConfigData &config);
57 
59  virtual ~BusPalUartPeripheral();
60 
62  void configure(const BusPal::BusPalConfigData &config);
63 
68  virtual status_t read(uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t timeoutMs);
69 
74  virtual status_t write(const uint8_t *buffer, uint32_t byteCount);
75 
76 protected:
78 };
79 
80 } // namespace blfwk
81 
83 
84 #endif // _BusPalPeripheral_h_
85 
87 // EOF
Interface with the BusPal.
Definition: BusPal.h:48
virtual status_t read(uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t timeoutMs)
Read bytes.
Definition: BusPalPeripheral.cpp:187
BusPalUartPeripheral(const char *port, long speed, const BusPal::BusPalConfigData &config)
Parameterized constructor that opens the serial port.
Definition: BusPalPeripheral.cpp:47
Definition: BlfwkErrors.h:16
Peripheral that talks to the target device over COM port hardware.
Definition: UartPeripheral.h:45
BusPal configuration data.
Definition: BusPal.h:101
void configure(const BusPal::BusPalConfigData &config)
configure the bus pal with the passed in options
Definition: BusPalPeripheral.cpp:69
virtual ~BusPalUartPeripheral()
Destructor.
Definition: BusPalPeripheral.cpp:64
virtual status_t write(const uint8_t *buffer, uint32_t byteCount)
Write bytes.
Definition: BusPalPeripheral.cpp:209
BusPal * m_busPal
Represents Bus Pal hardware.
Definition: BusPalPeripheral.h:77
Peripheral that talks to the target device over BusPal UART hardware.
Definition: BusPalPeripheral.h:45