Skip to content

W
White Rabbit core collection
Commit 3696c962 authored by Wesley W. Terpstra's avatar Wesley W. Terpstra
Browse files
Options

tlu: add c++ library to interface with TLU

parent 8cf061c6
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 704 additions and 0 deletions
modules/wr_tlu/Makefile 0 → 100644
View file @ 3696c962
PREFIX ?= /usr/local
STAGING ?=
EB ?= no
ifeq ($(EB),no)
EB_LIB ?= -letherbone
EB_INC ?=
else
EB_LIB ?= -L$(EB) -letherbone
EB_INC ?= -I$(EB)
endif
EXTRA_FLAGS ?=
CXX ?= g++
CXXFLAGS ?= $(EXTRA_FLAGS) -Wall -O2 -I. $(EB_INC)
TARGETS = libtlu.a tlu-ctl
all: $(TARGETS)
install:
mkdir -p $(STAGING)$(PREFIX)/bin $(STAGING)$(PREFIX)/include $(STAGING)$(PREFIX)/lib
cp tlu-ctl $(STAGING)$(PREFIX)/bin
cp tlu.h $(STAGING)$(PREFIX)/include
cp libtlu.a $(STAGING)$(PREFIX)/lib
clean:
rm -f $(TARGETS) *.o lib/*.o
tlu-ctl: tlu-ctl.o libtlu.a
$(CXX) $(CXXFLAGS) -o $@ $^ -Wl,-rpath,$(PREFIX)/lib $(EB_LIB)
libtlu.a: lib/tlu.o
rm -f $@
ar rcs $@ $^
ranlib $@
%.o: %.cpp
$(CXX) $(CXXFLAGS) -c $< -o $@
modules/wr_tlu/lib/hw-tlu.h 0 → 100644
View file @ 3696c962
#define GSI_VENDOR_ID 0x651
#define TLU_DEVICE_ID 0x10051981U
#define TLU_READY 0x00 //
#define TLU_CLEAR 0x04
#define TLU_TEST 0x08
#define TLU_ACTIVE_STATUS 0x0C
#define TLU_ACTIVE_SET 0x10
#define TLU_ACTIVE_CLR 0x14
#define TLU_EDGE_STATUS 0x18
#define TLU_EDGE_SET 0x1C
#define TLU_EDGE_CLR 0x20
#define TLU_INT_GLOBAL 0x24
#define TLU_INT_STATUS 0x28
#define TLU_INT_SET 0x2C
#define TLU_INT_CLR 0x30
#define TLU_NUM_CHANNELS 0x34
#define TLU_QUEUE_SIZE 0x38
#define TLU_TIME1 0x50
#define TLU_TIME0 0x54
#define TLU_CH_SELECT 0x58
#define TLU_CH_POP 0x5C
#define TLU_CH_TEST 0x60
#define TLU_CH_FILL_COUNT 0x64
#define TLU_CH_TIME1 0x68
#define TLU_CH_TIME0 0x6C
#define TLU_CH_SUB 0x70
#define TLU_CH_STABLE 0x74
#define TLU_CH_INT_DEST 0x78
#define TLU_CH_INT_MSG 0x7C
modules/wr_tlu/lib/tlu.cpp 0 → 100644
View file @ 3696c962
This diff is collapsed.
modules/wr_tlu/tlu-ctl.cpp 0 → 100644
View file @ 3696c962
int main(int argc, const char** argv) {
return 0;
}
modules/wr_tlu/tlu.h 0 → 100644
View file @ 3696c962
/** @file tlu.h
* @brief C++ Interface to the TLU hardware.
* @author Wesley W. Terpstra <w.terpstra@gsi.de>
*
* Copyright (C) 2014 GSI Helmholtz Centre for Heavy Ion Research GmbH
*
* Public API to control all aspects of the Timestamp Latch Unit.
*
*******************************************************************************
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*******************************************************************************
*/
#ifndef TLU_H
#define TLU_H
#include <etherbone.h>
#include <string>
#include <vector>
namespace GSI_TLU {
using namespace etherbone;
/* ======================================================================= */
/* Software interface to hardware timestamp latch unit */
/* ======================================================================= */
struct TLU {
/* ------------------------------------------------------------------- */
/* Constant hardware values */
/* ------------------------------------------------------------------- */
uint8_t sdb_ver_major;
uint8_t sdb_ver_minor;
uint32_t sdb_version;
uint32_t sdb_date;
std::string sdb_name;
uint32_t num_channels;
uint32_t queue_size;
/* ------------------------------------------------------------------- */
/* Mutable hardware registers; only modify using methods below */
/* ------------------------------------------------------------------- */
bool int_enable; /* Global interrupt enable */
uint64_t current_time; /* # of 1ns ticks since 1970 to last refresh */
struct Channel {
bool active; /* Listening for edges? */
bool pos_edge; /* Listen for positive/negative edge */
bool int_enable; /* Interrupt enable per channel */
uint32_t queued; /* Number of timestamps needing pop */
uint32_t stable; /* Time a signal must remain stable */
uint32_t int_dest; /* Destination of interrupt message */
uint32_t int_msg; /* Content of interrupt message */
};
std::vector<Channel> channels;
/* ------------------------------------------------------------------- */
/* Access/modify the underlying hardware */
/* ------------------------------------------------------------------- */
Device device; /* Device which hosts this ECA */
eb_address_t address; /* Wishbone base address */
/* Reload mutable registers from hardware */
status_t refresh();
/* Global interrupt enable */
status_t set_enable(bool enable);
/* Hook/unhook interrupt handling (channel -1 = all) */
status_t hook(int channel, bool enable, uint32_t dest = 0, uint32_t msg = 0);
/* Listen for positive/negative edge (channel -1 = all) */
status_t listen(int channel, bool enable, bool pos_edge, uint32_t stable = 8);
/* Clear the contents of a channel (channel -1 = all) */
status_t clear(int channel);
/* Inject a virtual timestamp for testing (channel -1 = all) */
status_t test(int channel, uint8_t edge);
/* Pop the next queued timestamp from the channel (units = 1ns step since 1970) */
status_t pop(int channel, uint64_t& time);
/* Pop all timestamps from a specific channel */
status_t pop_all(int channel, std::vector<uint64_t>& queue);
/* Pop all timestamps from all channels */
status_t pop_all(std::vector<std::vector<uint64_t> >& queues);
/* Find all TLUs in the SoC of a target device */
static status_t probe(Device dev, std::vector<TLU>& tlus);
};
}
#endif
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment