BusPalPeripheral.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 _BusPalPeripheral_h_
#define _BusPalPeripheral_h_
#include "UartPeripheral.h"
#include "BusPal.h"
namespace blfwk
{
class BusPalUartPeripheral : public UartPeripheral
{
public:
BusPalUartPeripheral(const char *port, long speed, const BusPal::BusPalConfigData &config);
virtual ~BusPalUartPeripheral();
void configure(const BusPal::BusPalConfigData &config);
virtual status_t read(uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t timeoutMs);
virtual status_t write(const uint8_t *buffer, uint32_t byteCount);
protected:
BusPal *m_busPal;
};
} // namespace blfwk
#endif // _BusPalPeripheral_h_
// EOF
blfwk::BusPal
Interface with the BusPal.
Definition: BusPal.h:48
blfwk::BusPalUartPeripheral::read
virtual status_t read(uint8_t *buffer, uint32_t requestedBytes, uint32_t *actualBytes, uint32_t timeoutMs)
Read bytes.
Definition: BusPalPeripheral.cpp:187
blfwk::BusPalUartPeripheral::BusPalUartPeripheral
BusPalUartPeripheral(const char *port, long speed, const BusPal::BusPalConfigData &config)
Parameterized constructor that opens the serial port.
Definition: BusPalPeripheral.cpp:47
blfwk
Definition: BlfwkErrors.h:16
blfwk::UartPeripheral
Peripheral that talks to the target device over COM port hardware.
Definition: UartPeripheral.h:45
blfwk::BusPal::BusPalConfigData
BusPal configuration data.
Definition: BusPal.h:101
blfwk::BusPalUartPeripheral::configure
void configure(const BusPal::BusPalConfigData &config)
configure the bus pal with the passed in options
Definition: BusPalPeripheral.cpp:69
blfwk::BusPalUartPeripheral::~BusPalUartPeripheral
virtual ~BusPalUartPeripheral()
Destructor.
Definition: BusPalPeripheral.cpp:64
blfwk::BusPalUartPeripheral::write
virtual status_t write(const uint8_t *buffer, uint32_t byteCount)
Write bytes.
Definition: BusPalPeripheral.cpp:209
blfwk::BusPalUartPeripheral::m_busPal
BusPal * m_busPal
Represents Bus Pal hardware.
Definition: BusPalPeripheral.h:77
blfwk::BusPalUartPeripheral
Peripheral that talks to the target device over BusPal UART hardware.
Definition: BusPalPeripheral.h:45