Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
TivaRailcom.hxx File Reference
#include "freertos_drivers/common/RailcomImpl.hxx"
#include "dcc/RailCom.hxx"

Go to the source code of this file.

Classes

class  TivaRailcomDriver< HW >
 Railcom driver for TI Tiva-class microcontrollers using the TivaWare peripheral library. More...
 

Detailed Description

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • 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.

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.

Device driver for TivaWare to read one or more UART inputs for railcom data.

usage:

struct MyRailcomPins { // add all definitions from the example RailcomHw here }; // Some definitions need to go outside of the class. // no need for attribute weak if this is in a .cxx file. const uint32_t MyRailcomPins::UART_BASE[] attribute((weak)) = {...}; ...

TivaRailcomDriver<MyrailcomPins> railcom_driver("/dev/railcom");

// assuming you put OS_INTERRRUPT = INT_UART3 into the structure. void uart3_interrupt_handler() { railcom_driver.os_interrrupt(); }

Then open /dev/railcom and read dcc::Feedback structures from it. Each read much be exactly sizeof(dcc::Feedback) length. If there are no more packets to read, you'll get return=0, errno==EAGAIN. Add an ioctl CAN_READ_ACTIVE to get a notification when there is something to read.

Author
Balazs Racz
Date
6 Jan 2015

Definition in file TivaRailcom.hxx.