UartPeripheral.h
/*
* Copyright (c) 2013-14, 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 _uart_peripheral_h_
#define _uart_peripheral_h_
#include "Peripheral.h"
#include "packet/command_packet.h"
namespace blfwk
{
class UartPeripheral : public Peripheral
{
public:
enum _uart_peripheral_constants
{
// The read() implementation for the UartPeripheral does not use this the timeout parameter.
kUartPeripheral_UnusedTimeout = 0,
// Serial timeout is set to this default during init().
kUartPeripheral_DefaultReadTimeoutMs = 1000,
kUartPeripheral_DefaultBaudRate = 9600
};
public:
UartPeripheral(const char *port, long speed = kUartPeripheral_DefaultBaudRate);
virtual ~UartPeripheral();
void flushRX();
virtual status_t read(uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t unused_timeoutMs);
virtual status_t write(const uint8_t *buffer, uint32_t byteCount);
protected:
bool init(const char *port, long speed);
int m_fileDescriptor;
uint8_t m_buffer[kDefaultMaxPacketSize];
};
} // namespace blfwk
#endif // _uart_peripheral_h_
// EOF
blfwk
Definition: BlfwkErrors.h:16
blfwk::UartPeripheral
Peripheral that talks to the target device over COM port hardware.
Definition: UartPeripheral.h:45
blfwk::UartPeripheral::flushRX
void flushRX()
Flush.
Definition: UartPeripheral.cpp:126
blfwk::UartPeripheral::m_fileDescriptor
int m_fileDescriptor
Port file descriptor.
Definition: UartPeripheral.h:102
blfwk::UartPeripheral::_uart_peripheral_constants
_uart_peripheral_constants
Constants.
Definition: UartPeripheral.h:49
blfwk::UartPeripheral::write
virtual status_t write(const uint8_t *buffer, uint32_t byteCount)
Write bytes.
Definition: UartPeripheral.cpp:145
blfwk::UartPeripheral::UartPeripheral
UartPeripheral(const char *port, long speed=kUartPeripheral_DefaultBaudRate)
Parameterized constructor that opens the serial port.
Definition: UartPeripheral.cpp:43
blfwk::UartPeripheral::m_buffer
uint8_t m_buffer[kDefaultMaxPacketSize]
Buffer for bytes used to build read packet.
Definition: UartPeripheral.h:103
blfwk::UartPeripheral::init
bool init(const char *port, long speed)
Initialize.
Definition: UartPeripheral.cpp:54
blfwk::Peripheral
Represents a peripheral.
Definition: Peripheral.h:48
blfwk::UartPeripheral::read
virtual status_t read(uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t unused_timeoutMs)
Read bytes.
Definition: UartPeripheral.cpp:87
blfwk::UartPeripheral::~UartPeripheral
virtual ~UartPeripheral()
Destructor.
Definition: UartPeripheral.cpp:78