From 2838d1e3e927042921ba2f06a90a79fcdd0915df Mon Sep 17 00:00:00 2001 From: Oliver Bruendler Date: Tue, 12 Nov 2019 14:38:42 +0100 Subject: [PATCH] DOC: Fixed documentation (use strHandle instead of ipHandle in example code) --- .../dir_1284b95147afa48b330f502c8bbc0529.html | 2 +- doc/api/html/index.html | 2 +- doc/api/html/psi__ms__daq_8h.html | 2 +- doc/api/html/psi__ms__daq_8h_source.html | 86 +++++++++---------- .../struct_psi_ms_daq___access_fct__t.html | 2 +- .../struct_psi_ms_daq___str_config__t.html | 2 +- .../html/struct_psi_ms_daq___win_info__t.html | 2 +- driver/psi_ms_daq.h | 8 +- 8 files changed, 53 insertions(+), 53 deletions(-) diff --git a/doc/api/html/dir_1284b95147afa48b330f502c8bbc0529.html b/doc/api/html/dir_1284b95147afa48b330f502c8bbc0529.html index 79a8529..c8856d1 100644 --- a/doc/api/html/dir_1284b95147afa48b330f502c8bbc0529.html +++ b/doc/api/html/dir_1284b95147afa48b330f502c8bbc0529.html @@ -5,7 +5,7 @@ -Driver Documentation: D:/gfa/Libraries/Firmware/VHDL/psi_multi_stream_daq/driver Directory Reference +Driver Documentation: D:/gfa/RF/HIPA/LLRF_v1/post_mortem/Lib/VHDL/psi_multi_stream_daq/driver Directory Reference diff --git a/doc/api/html/index.html b/doc/api/html/index.html index 21371e3..7414dea 100644 --- a/doc/api/html/index.html +++ b/doc/api/html/index.html @@ -113,7 +113,7 @@ Stream based IRQ

Example Code

This section contains a little code example to show how the driver is used.

-
//*** Static Variables ***
static PsiMsDaq_IpHandle daqHandle;
static PsiMsDaq_StrHandle daqStrHandle;
//*** System ISR ***
//ISR that is called by the OS/baremetal drivers if an IRQ is asserted
void PsiMsDaqIrqHandler(void* arg)
{
//We assume the handle to the psi_ms_daq driver is passed as callback argument
PsiMsDaq_IpHandle ipHandle = (PsiMsDaq_IpHandle) arg;
//Call IP-handling function
PsiMsDaq_HandleIrq(ipHandle);
}
//*** IP User ISR ***
void UserDaqIsr(PsiMsDaq_WinInfo_t winInfo, void* arg)
{
//Invalidate cache, example code is for xilinx devices
Xil_DCacheInvalidateRange(<recodingLocation>, <recordingSize>);
//Get recorded data
PsiMsDaq_StrWin_GetDataUnwrapped(winInfo, <preTriggerSize>, <postTriggerSize>, <targetBuffer>, sizeof(<targetBuffer>));
//Acknowledge processing of the data
PsiMsDaq_StrWin_MarkAsFree(winInfo);
}
//*** Main function containing intialization ***
int main()
{
//Initialize IP
daqHandle = PsiMsDaq_Init(<baseAddress>, <streams>, <maxWindows>, NULL);
PsiMsDaq_GetStrHandle(daqHandle, 0, &daqStrHandle);
//Configure Stream
PsiMsDaq_StrConfig_t cfg = {
.postTrigSamples = <postTriggerSamplesToRecord>,
.recMode = <mode>,
.winAsRingbuf = true,
.winOverwrite = false,
.winCnt = <numberOfWindowsForThisStream>,
.bufStartAddr = <recodingLocation>,
.winSize = <sizePerWindow>, //in bytes
.streamWidthBits = <widthInBits>
};
PsiMsDaq_Str_Configure(daqHandle, &cfg);
//Register ballback
PsiMsDaq_Str_SetIrqCallbackWin(daqHandle, UserDaqIsr, NULL);
//Enable IRQ
PsiMsDaq_Str_SetIrqEnable(daqHandle, true);
//Enable recorder for stream
PsiMsDaq_Str_SetEnable(daqHandle, true);
//Wait in endless loop for IRQs comming in
while(1){};
}
+
// *** Static Variables ***
static PsiMsDaq_IpHandle daqHandle;
static PsiMsDaq_StrHandle daqStrHandle;
// *** System ISR ***
//ISR that is called by the OS/baremetal drivers if an IRQ is asserted
void PsiMsDaqIrqHandler(void* arg)
{
//We assume the handle to the psi_ms_daq driver is passed as callback argument
PsiMsDaq_IpHandle ipHandle = (PsiMsDaq_IpHandle) arg;
//Call IP-handling function
PsiMsDaq_HandleIrq(ipHandle);
}
// *** IP User ISR ***
void UserDaqIsr(PsiMsDaq_WinInfo_t winInfo, void* arg)
{
//Invalidate cache, example code is for xilinx devices
Xil_DCacheInvalidateRange(<recodingLocation>, <recordingSize>);
//Get recorded data
PsiMsDaq_StrWin_GetDataUnwrapped(winInfo, <preTriggerSize>, <postTriggerSize>, <targetBuffer>, sizeof(<targetBuffer>));
//Acknowledge processing of the data
PsiMsDaq_StrWin_MarkAsFree(winInfo);
}
// *** Main function containing intialization ***
int main()
{
//Initialize IP
daqHandle = PsiMsDaq_Init(<baseAddress>, <streams>, <maxWindows>, NULL);
PsiMsDaq_GetStrHandle(daqHandle, 0, &daqStrHandle);
//Configure Stream
PsiMsDaq_StrConfig_t cfg = {
.postTrigSamples = <postTriggerSamplesToRecord>,
.recMode = <mode>,
.winAsRingbuf = true,
.winOverwrite = false,
.winCnt = <numberOfWindowsForThisStream>,
.bufStartAddr = <recodingLocation>,
.winSize = <sizePerWindow>, //in bytes
.streamWidthBits = <widthInBits>
};
PsiMsDaq_Str_Configure(daqStrHandle, &cfg);
//Register ballback
PsiMsDaq_Str_SetIrqCallbackWin(daqStrHandle, UserDaqIsr, NULL);
//Enable IRQ
PsiMsDaq_Str_SetIrqEnable(daqStrHandle, true);
//Enable recorder for stream
PsiMsDaq_Str_SetEnable(daqStrHandle, true);
//Wait in endless loop for IRQs comming in
while(1){};
}
-Go to the documentation of this file.
1 #pragma once
2 
3 //*******************************************************************************
4 // Documentation
5 //*******************************************************************************
124 //*******************************************************************************
125 // Includes
126 //*******************************************************************************
127 #include <stdint.h>
128 #include <stdbool.h>
129 #include <string.h>
130 
131 //*******************************************************************************
132 // Constants
133 //*******************************************************************************
134 
136 //ACQCONF Registers - General
137 #define PSI_MS_DAQ_REG_GCFG 0x000
138 #define PSI_MS_DAQ_REG_GCFG_BIT_ENA (1 << 0)
139 #define PSI_MS_DAQ_REG_GCFG_BIT_IRQENA (1 << 8)
140 #define PSI_MS_DAQ_REG_GSTAT 0x004
141 #define PSI_MS_DAQ_REG_IRQVEC 0x010
142 #define PSI_MS_DAQ_REG_IRQENA 0x014
143 #define PSI_MS_DAQ_REG_STRENA 0x020
144 //ACQCONF Registers - Per Stream
145 #define PSI_MS_DAQ_REG_MAXLVL(n) (0x200+0x10*(n))
146 #define PSI_MS_DAQ_REG_POSTTRIG(n) (0x204+0x10*(n))
147 #define PSI_MS_DAQ_REG_MODE(n) (0x208+0x10*(n))
148 #define PSI_MS_DAQ_REG_MODE_LSB_RECM 0
149 #define PSI_MS_DAQ_REG_MODE_MSB_RECM 1
150 #define PSI_MS_DAQ_REG_MODE_BIT_ARM (1 << 8)
151 #define PSI_MS_DAQ_REG_MODE_BIT_REC (1 << 16)
152 #define PSI_MS_DAQ_REG_LASTWIN(n) (0x20C+0x10*(n))
153 //CTXMEM for Stream n
154 #define PSI_MS_DAQ_CTX_SCFG(n) (0x1000+0x20*(n))
155 #define PSI_MS_DAQ_CTX_SCFG_BIT_RINGBUF (1 << 0)
156 #define PSI_MS_DAQ_CTX_SCFG_BIT_OVERWRITE (1 << 8)
157 #define PSI_MS_DAQ_CTX_SCFG_LSB_WINCNT 16
158 #define PSI_MS_DAQ_CTX_SCFG_MSB_WINCNT 20
159 #define PSI_MS_DAQ_CTX_SCFG_LSB_WINCUR 24
160 #define PSI_MS_DAQ_CTX_SCFG_MSB_WINCUR 28
161 #define PSI_MS_DAQ_CTX_BUFSTART(n) (0x1004+0x20*(n))
162 #define PSI_MS_DAQ_CTX_WINSIZE(n) (0x1008+0x20*(n))
163 #define PSI_MS_DAQ_CTX_PTR(n) (0x100C+0x20*(n))
164 #define PSI_MS_DAQ_CTX_WINEND(n) (0x1010+0x20*(n))
165 //WNDW Window w for Stream n
166 #define PSI_MS_DAQ_WIN_WINCNT(n, w, so) (0x4000+(so)*(n)+0x10*(w))
167 #define PSI_MS_DAQ_WIN_WINCNT_LSB_CNT 0
168 #define PSI_MS_DAQ_WIN_WINCNT_MSB_CNT 30
169 #define PSI_MS_DAQ_WIN_WINCNT_BIT_ISTRIG (1 << 31)
170 #define PSI_MS_DAQ_WIN_LAST(n, w, so) (0x4004+(so)*(n)+0x10*(w))
171 #define PSI_MS_DAQ_WIN_TSLO(n, w, so) (0x4008+(so)*(n)+0x10*(w))
172 #define PSI_MS_DAQ_WIN_TSHI(n, w, so) (0x400C+(so)*(n)+0x10*(w))
173 
175 //*******************************************************************************
176 // Types
177 //*******************************************************************************
178 
179 //*** Handles ***
180 typedef void* PsiMsDaq_IpHandle;
181 typedef void* PsiMsDaq_StrHandle;
182 
183 //*** Functions for access to data of the IP core ***
191 typedef void PsiMsDaq_DataCopy_f(void* dst, void* src, size_t n);
192 
199 typedef void PsiMsDaq_RegWrite_f(const uint32_t addr, const uint32_t value);
200 
207 typedef uint32_t PsiMsDaq_RegRead_f(const uint32_t addr);
208 
214 typedef struct {
215  uint8_t winNr;
216  PsiMsDaq_IpHandle ipHandle;
217  PsiMsDaq_StrHandle strHandle;
218 }PsiMsDaq_WinInfo_t;
219 
229 typedef void PsiMsDaqn_WinIrq_f(PsiMsDaq_WinInfo_t winInfo, void* arg);
230 
240 typedef void PsiMsDaqn_StrIrq_f(PsiMsDaq_StrHandle strHandle, void* arg);
241 
245 typedef enum {
246  PsiMsDaqn_RecMode_Continuous = 0,
247  PsiMsDaqn_RecMode_TriggerMask = 1,
248  PsiMsDaqn_RecMode_SingleShot = 2,
249  PsiMsDaqn_RecMode_Manual = 3,
250 } PsiMsDaq_RecMode_t;
251 
255 typedef struct {
256  uint32_t postTrigSamples;
257  PsiMsDaq_RecMode_t recMode;
258  bool winAsRingbuf;
259  bool winOverwrite;
260  uint8_t winCnt;
261  uint32_t bufStartAddr;
262  uint32_t winSize;
263  uint16_t streamWidthBits;
264 } PsiMsDaq_StrConfig_t;
265 
269 typedef struct {
270  PsiMsDaq_DataCopy_f* dataCopy;
271  PsiMsDaq_RegWrite_f* regWrite;
272  PsiMsDaq_RegRead_f* regRead;
273 } PsiMsDaq_AccessFct_t;
274 
278 typedef enum {
279  PsiMsDaq_RetCode_Success = 0,
280  PsiMsDaq_RetCode_IllegalStrNr = -1,
281  PsiMsDaq_RetCode_IllegalStrWidth = -2,
282  PsiMsDaq_RetCode_StrNotDisabled = -3,
283  PsiMsDaq_RetCode_IllegalWinCnt = -4,
284  PsiMsDaq_RetCode_IllegalWinNr = -5,
285  PsiMsDaq_RetCode_NoTrigInWin = -6,
286  PsiMsDaq_RetCode_BufferTooSmall = -7,
287  PsiMsDaq_RetCode_MorePostTrigThanConfigured = -8,
288  PsiMsDaq_RetCode_MorePreTrigThanAvailable = -9,
289  PsiMsDaq_RetCode_WinSizeMustBeMultipleOfSamples = -10,
290  PsiMsDaq_RetCode_IrqSchemesWinAndStrAreExclusive = -11
291 } PsiMsDaq_RetCode_t;
292 
293 //*******************************************************************************
294 // IP Wide Functions
295 //*******************************************************************************
296 
306 PsiMsDaq_IpHandle PsiMsDaq_Init( const uint32_t baseAddr,
307  const uint8_t maxStreams,
308  const uint8_t maxWindows,
309  const PsiMsDaq_AccessFct_t* const accessFct_p);
310 
311 
320 PsiMsDaq_RetCode_t PsiMsDaq_GetStrHandle( PsiMsDaq_IpHandle ipHandle,
321  const uint8_t streamNr,
322  PsiMsDaq_StrHandle* const strHndl_p);
323 
324 
325 void PsiMsDaq_HandleIrq(PsiMsDaq_IpHandle inst_p);
326 
327 
328 
329 //*******************************************************************************
330 // Stream Related Functions
331 //*******************************************************************************
332 
342 PsiMsDaq_RetCode_t PsiMsDaq_Str_Configure( PsiMsDaq_StrHandle strHndl,
343  PsiMsDaq_StrConfig_t* const config_p);
344 
352 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetEnable( PsiMsDaq_StrHandle strHndl,
353  const bool enable);
354 
368 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqCallbackWin( PsiMsDaq_StrHandle strHndl,
369  PsiMsDaqn_WinIrq_f* irqCb,
370  void* arg_p);
371 
386 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqCallbackStr( PsiMsDaq_StrHandle strHndl,
387  PsiMsDaqn_StrIrq_f* irqCb,
388  void* arg_p);
389 
397 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqEnable( PsiMsDaq_StrHandle strHndl,
398  const bool irqEna);
399 
406 PsiMsDaq_RetCode_t PsiMsDaq_Str_Arm(PsiMsDaq_StrHandle strHndl);
407 
408 
416 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetMaxLvl( PsiMsDaq_StrHandle strHndl,
417  uint32_t* const maxLvl_p);
418 
430 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetFreeWindows( PsiMsDaq_StrHandle strHndl,
431  uint8_t* const freeWindows_p);
432 
444 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetUsedWindows( PsiMsDaq_StrHandle strHndl,
445  uint8_t* const usedWindows_p);
446 
454 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetTotalWindows( PsiMsDaq_StrHandle strHndl,
455  uint8_t* const windows_p);
456 
464 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetIpHandle( PsiMsDaq_StrHandle strHndl,
465  PsiMsDaq_IpHandle* ipHandle_p);
466 
474 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetStrNr( PsiMsDaq_StrHandle strHndl,
475  uint8_t* strNr_p);
476 
477 
478 //*******************************************************************************
479 // Window Related Functions
480 //*******************************************************************************
481 
489 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetNoOfBytes( PsiMsDaq_WinInfo_t winInfo,
490  uint32_t* const noOfBytes_p);
491 
499 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetNoOfSamples( PsiMsDaq_WinInfo_t winInfo,
500  uint32_t* const noOfSamples_p);
501 
509 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetPreTrigSamples( PsiMsDaq_WinInfo_t winInfo,
510  uint32_t* const preTrigSamples_p);
511 
519 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetTimestamp( PsiMsDaq_WinInfo_t winInfo,
520  uint64_t* const timestamp_p);
521 
534 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetDataUnwrapped( PsiMsDaq_WinInfo_t winInfo,
535  const uint32_t preTrigSamples,
536  const uint32_t postTrigSamples, //including trigger
537  void* const buffer_p,
538  const size_t bufferSize);
539 
546 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_MarkAsFree( PsiMsDaq_WinInfo_t winInfo);
547 
555 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetLastSplAddr( PsiMsDaq_WinInfo_t winInfo,
556  uint32_t* const lastSplAddr_p);
557 
558 //*******************************************************************************
559 // Advanced Functions (only required for close control)
560 //*******************************************************************************
561 
569 PsiMsDaq_RetCode_t PsiMsDaq_Str_IsRecording( PsiMsDaq_StrHandle strHndl,
570  bool* const isRecording_p);
571 
579 PsiMsDaq_RetCode_t PsiMsDaq_Str_CurrentWin( PsiMsDaq_StrHandle strHndl,
580  uint8_t* const currentWin_p);
581 
589 PsiMsDaq_RetCode_t PsiMsDaq_Str_CurrentPtr( PsiMsDaq_StrHandle strHndl,
590  uint32_t* const currentPtr_p);
591 
599 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetLastWrittenWin( PsiMsDaq_StrHandle strHndl,
600  uint8_t* const lastWrittenWin_p);
601 
613 PsiMsDaq_RetCode_t PsiMsDaq_RegWrite( PsiMsDaq_IpHandle ipHandle,
614  const uint32_t addr,
615  const uint32_t value);
616 
625 PsiMsDaq_RetCode_t PsiMsDaq_RegRead( PsiMsDaq_IpHandle ipHandle,
626  const uint32_t addr,
627  uint32_t* const value_p);
628 
642 PsiMsDaq_RetCode_t PsiMsDaq_RegSetField( PsiMsDaq_IpHandle ipHandle,
643  const uint32_t addr,
644  const uint8_t lsb,
645  const uint8_t msb,
646  const uint32_t value);
647 
658 PsiMsDaq_RetCode_t PsiMsDaq_RegGetField( PsiMsDaq_IpHandle ipHandle,
659  const uint32_t addr,
660  const uint8_t lsb,
661  const uint8_t msb,
662  uint32_t* const value_p);
663 
676 PsiMsDaq_RetCode_t PsiMsDaq_RegSetBit( PsiMsDaq_IpHandle ipHandle,
677  const uint32_t addr,
678  const uint32_t mask,
679  const bool value);
680 
690 PsiMsDaq_RetCode_t PsiMsDaq_RegGetBit( PsiMsDaq_IpHandle ipHandle,
691  const uint32_t addr,
692  const uint32_t mask,
693  bool* const value_p);
694 
695 
696 
697 
698 
PsiMsDaq_RetCode_IllegalStrWidth
Illegal steram width selected.
Definition: psi_ms_daq.h:281
+Go to the documentation of this file.
1 /*############################################################################
2 # Copyright (c) 2019 by Paul Scherrer Institute, Switzerland
3 # All rights reserved.
4 # Authors: Oliver Bruendler
5 ############################################################################*/
6 
7 #pragma once
8 
9 #ifdef __cplusplus
10 extern "C" {
11 #endif
12 
13 //*******************************************************************************
14 // Documentation
15 //*******************************************************************************
134 //*******************************************************************************
135 // Includes
136 //*******************************************************************************
137 #include <stdint.h>
138 #include <stdbool.h>
139 #include <string.h>
140 
141 //*******************************************************************************
142 // Constants
143 //*******************************************************************************
144 
146 //ACQCONF Registers - General
147 #define PSI_MS_DAQ_REG_GCFG 0x000
148 #define PSI_MS_DAQ_REG_GCFG_BIT_ENA (1 << 0)
149 #define PSI_MS_DAQ_REG_GCFG_BIT_IRQENA (1 << 8)
150 #define PSI_MS_DAQ_REG_GSTAT 0x004
151 #define PSI_MS_DAQ_REG_IRQVEC 0x010
152 #define PSI_MS_DAQ_REG_IRQENA 0x014
153 #define PSI_MS_DAQ_REG_STRENA 0x020
154 //ACQCONF Registers - Per Stream
155 #define PSI_MS_DAQ_REG_MAXLVL(n) (0x200+0x10*(n))
156 #define PSI_MS_DAQ_REG_POSTTRIG(n) (0x204+0x10*(n))
157 #define PSI_MS_DAQ_REG_MODE(n) (0x208+0x10*(n))
158 #define PSI_MS_DAQ_REG_MODE_LSB_RECM 0
159 #define PSI_MS_DAQ_REG_MODE_MSB_RECM 1
160 #define PSI_MS_DAQ_REG_MODE_BIT_ARM (1 << 8)
161 #define PSI_MS_DAQ_REG_MODE_BIT_REC (1 << 16)
162 #define PSI_MS_DAQ_REG_LASTWIN(n) (0x20C+0x10*(n))
163 //CTXMEM for Stream n
164 #define PSI_MS_DAQ_CTX_SCFG(n) (0x1000+0x20*(n))
165 #define PSI_MS_DAQ_CTX_SCFG_BIT_RINGBUF (1 << 0)
166 #define PSI_MS_DAQ_CTX_SCFG_BIT_OVERWRITE (1 << 8)
167 #define PSI_MS_DAQ_CTX_SCFG_LSB_WINCNT 16
168 #define PSI_MS_DAQ_CTX_SCFG_MSB_WINCNT 20
169 #define PSI_MS_DAQ_CTX_SCFG_LSB_WINCUR 24
170 #define PSI_MS_DAQ_CTX_SCFG_MSB_WINCUR 28
171 #define PSI_MS_DAQ_CTX_BUFSTART(n) (0x1004+0x20*(n))
172 #define PSI_MS_DAQ_CTX_WINSIZE(n) (0x1008+0x20*(n))
173 #define PSI_MS_DAQ_CTX_PTR(n) (0x100C+0x20*(n))
174 #define PSI_MS_DAQ_CTX_WINEND(n) (0x1010+0x20*(n))
175 //WNDW Window w for Stream n
176 #define PSI_MS_DAQ_WIN_WINCNT(n, w, so) (0x4000+(so)*(n)+0x10*(w))
177 #define PSI_MS_DAQ_WIN_WINCNT_LSB_CNT 0
178 #define PSI_MS_DAQ_WIN_WINCNT_MSB_CNT 30
179 #define PSI_MS_DAQ_WIN_WINCNT_BIT_ISTRIG (1 << 31)
180 #define PSI_MS_DAQ_WIN_LAST(n, w, so) (0x4004+(so)*(n)+0x10*(w))
181 #define PSI_MS_DAQ_WIN_TSLO(n, w, so) (0x4008+(so)*(n)+0x10*(w))
182 #define PSI_MS_DAQ_WIN_TSHI(n, w, so) (0x400C+(so)*(n)+0x10*(w))
183 
185 //*******************************************************************************
186 // Types
187 //*******************************************************************************
188 
189 //*** Handles ***
190 typedef void* PsiMsDaq_IpHandle;
191 typedef void* PsiMsDaq_StrHandle;
192 
193 //*** Functions for access to data of the IP core ***
201 typedef void PsiMsDaq_DataCopy_f(void* dst, void* src, size_t n);
202 
209 typedef void PsiMsDaq_RegWrite_f(const uint32_t addr, const uint32_t value);
210 
217 typedef uint32_t PsiMsDaq_RegRead_f(const uint32_t addr);
218 
224 typedef struct {
225  uint8_t winNr;
226  PsiMsDaq_IpHandle ipHandle;
227  PsiMsDaq_StrHandle strHandle;
228 }PsiMsDaq_WinInfo_t;
229 
239 typedef void PsiMsDaqn_WinIrq_f(PsiMsDaq_WinInfo_t winInfo, void* arg);
240 
250 typedef void PsiMsDaqn_StrIrq_f(PsiMsDaq_StrHandle strHandle, void* arg);
251 
255 typedef enum {
256  PsiMsDaqn_RecMode_Continuous = 0,
257  PsiMsDaqn_RecMode_TriggerMask = 1,
258  PsiMsDaqn_RecMode_SingleShot = 2,
259  PsiMsDaqn_RecMode_Manual = 3
260 } PsiMsDaq_RecMode_t;
261 
265 typedef struct {
266  uint32_t postTrigSamples;
267  PsiMsDaq_RecMode_t recMode;
268  bool winAsRingbuf;
269  bool winOverwrite;
270  uint8_t winCnt;
271  uint32_t bufStartAddr;
272  uint32_t winSize;
273  uint16_t streamWidthBits;
274 } PsiMsDaq_StrConfig_t;
275 
279 typedef struct {
280  PsiMsDaq_DataCopy_f* dataCopy;
281  PsiMsDaq_RegWrite_f* regWrite;
282  PsiMsDaq_RegRead_f* regRead;
283 } PsiMsDaq_AccessFct_t;
284 
288 typedef enum {
289  PsiMsDaq_RetCode_Success = 0,
290  PsiMsDaq_RetCode_IllegalStrNr = -1,
291  PsiMsDaq_RetCode_IllegalStrWidth = -2,
292  PsiMsDaq_RetCode_StrNotDisabled = -3,
293  PsiMsDaq_RetCode_IllegalWinCnt = -4,
294  PsiMsDaq_RetCode_IllegalWinNr = -5,
295  PsiMsDaq_RetCode_NoTrigInWin = -6,
296  PsiMsDaq_RetCode_BufferTooSmall = -7,
297  PsiMsDaq_RetCode_MorePostTrigThanConfigured = -8,
298  PsiMsDaq_RetCode_MorePreTrigThanAvailable = -9,
299  PsiMsDaq_RetCode_WinSizeMustBeMultipleOfSamples = -10,
300  PsiMsDaq_RetCode_IrqSchemesWinAndStrAreExclusive = -11
301 } PsiMsDaq_RetCode_t;
302 
303 //*******************************************************************************
304 // IP Wide Functions
305 //*******************************************************************************
306 
316 PsiMsDaq_IpHandle PsiMsDaq_Init( const uint32_t baseAddr,
317  const uint8_t maxStreams,
318  const uint8_t maxWindows,
319  const PsiMsDaq_AccessFct_t* const accessFct_p);
320 
321 
330 PsiMsDaq_RetCode_t PsiMsDaq_GetStrHandle( PsiMsDaq_IpHandle ipHandle,
331  const uint8_t streamNr,
332  PsiMsDaq_StrHandle* const strHndl_p);
333 
334 
335 void PsiMsDaq_HandleIrq(PsiMsDaq_IpHandle inst_p);
336 
337 
338 
339 //*******************************************************************************
340 // Stream Related Functions
341 //*******************************************************************************
342 
352 PsiMsDaq_RetCode_t PsiMsDaq_Str_Configure( PsiMsDaq_StrHandle strHndl,
353  PsiMsDaq_StrConfig_t* const config_p);
354 
362 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetEnable( PsiMsDaq_StrHandle strHndl,
363  const bool enable);
364 
378 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqCallbackWin( PsiMsDaq_StrHandle strHndl,
379  PsiMsDaqn_WinIrq_f* irqCb,
380  void* arg_p);
381 
396 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqCallbackStr( PsiMsDaq_StrHandle strHndl,
397  PsiMsDaqn_StrIrq_f* irqCb,
398  void* arg_p);
399 
407 PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqEnable( PsiMsDaq_StrHandle strHndl,
408  const bool irqEna);
409 
416 PsiMsDaq_RetCode_t PsiMsDaq_Str_Arm(PsiMsDaq_StrHandle strHndl);
417 
418 
426 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetMaxLvl( PsiMsDaq_StrHandle strHndl,
427  uint32_t* const maxLvl_p);
428 
440 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetFreeWindows( PsiMsDaq_StrHandle strHndl,
441  uint8_t* const freeWindows_p);
442 
454 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetUsedWindows( PsiMsDaq_StrHandle strHndl,
455  uint8_t* const usedWindows_p);
456 
464 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetTotalWindows( PsiMsDaq_StrHandle strHndl,
465  uint8_t* const windows_p);
466 
474 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetIpHandle( PsiMsDaq_StrHandle strHndl,
475  PsiMsDaq_IpHandle* ipHandle_p);
476 
484 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetStrNr( PsiMsDaq_StrHandle strHndl,
485  uint8_t* strNr_p);
486 
487 
488 //*******************************************************************************
489 // Window Related Functions
490 //*******************************************************************************
491 
499 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetNoOfBytes( PsiMsDaq_WinInfo_t winInfo,
500  uint32_t* const noOfBytes_p);
501 
509 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetNoOfSamples( PsiMsDaq_WinInfo_t winInfo,
510  uint32_t* const noOfSamples_p);
511 
519 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetPreTrigSamples( PsiMsDaq_WinInfo_t winInfo,
520  uint32_t* const preTrigSamples_p);
521 
529 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetTimestamp( PsiMsDaq_WinInfo_t winInfo,
530  uint64_t* const timestamp_p);
531 
544 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetDataUnwrapped( PsiMsDaq_WinInfo_t winInfo,
545  const uint32_t preTrigSamples,
546  const uint32_t postTrigSamples, //including trigger
547  void* const buffer_p,
548  const size_t bufferSize);
549 
556 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_MarkAsFree( PsiMsDaq_WinInfo_t winInfo);
557 
565 PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetLastSplAddr( PsiMsDaq_WinInfo_t winInfo,
566  uint32_t* const lastSplAddr_p);
567 
568 //*******************************************************************************
569 // Advanced Functions (only required for close control)
570 //*******************************************************************************
571 
579 PsiMsDaq_RetCode_t PsiMsDaq_Str_IsRecording( PsiMsDaq_StrHandle strHndl,
580  bool* const isRecording_p);
581 
589 PsiMsDaq_RetCode_t PsiMsDaq_Str_CurrentWin( PsiMsDaq_StrHandle strHndl,
590  uint8_t* const currentWin_p);
591 
599 PsiMsDaq_RetCode_t PsiMsDaq_Str_CurrentPtr( PsiMsDaq_StrHandle strHndl,
600  uint32_t* const currentPtr_p);
601 
609 PsiMsDaq_RetCode_t PsiMsDaq_Str_GetLastWrittenWin( PsiMsDaq_StrHandle strHndl,
610  uint8_t* const lastWrittenWin_p);
611 
623 PsiMsDaq_RetCode_t PsiMsDaq_RegWrite( PsiMsDaq_IpHandle ipHandle,
624  const uint32_t addr,
625  const uint32_t value);
626 
635 PsiMsDaq_RetCode_t PsiMsDaq_RegRead( PsiMsDaq_IpHandle ipHandle,
636  const uint32_t addr,
637  uint32_t* const value_p);
638 
652 PsiMsDaq_RetCode_t PsiMsDaq_RegSetField( PsiMsDaq_IpHandle ipHandle,
653  const uint32_t addr,
654  const uint8_t lsb,
655  const uint8_t msb,
656  const uint32_t value);
657 
668 PsiMsDaq_RetCode_t PsiMsDaq_RegGetField( PsiMsDaq_IpHandle ipHandle,
669  const uint32_t addr,
670  const uint8_t lsb,
671  const uint8_t msb,
672  uint32_t* const value_p);
673 
686 PsiMsDaq_RetCode_t PsiMsDaq_RegSetBit( PsiMsDaq_IpHandle ipHandle,
687  const uint32_t addr,
688  const uint32_t mask,
689  const bool value);
690 
700 PsiMsDaq_RetCode_t PsiMsDaq_RegGetBit( PsiMsDaq_IpHandle ipHandle,
701  const uint32_t addr,
702  const uint32_t mask,
703  bool* const value_p);
704 
705 #ifdef __cplusplus
706 }
707 #endif
708 
709 
710 
711 
712 
PsiMsDaq_RetCode_IllegalStrWidth
Illegal steram width selected.
Definition: psi_ms_daq.h:291
PsiMsDaq_StrWin_GetDataUnwrapped
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetDataUnwrapped(PsiMsDaq_WinInfo_t winInfo, const uint32_t preTrigSamples, const uint32_t postTrigSamples, void *const buffer_p, const size_t bufferSize)
Get unwrapped copy of the data in a window.
-
PsiMsDaq_WinInfo_t::ipHandle
PsiMsDaq_IpHandle ipHandle
Handle of the IP the window belongs to.
Definition: psi_ms_daq.h:216
-
PsiMsDaq_AccessFct_t::dataCopy
PsiMsDaq_DataCopy_f * dataCopy
Data copy function to use.
Definition: psi_ms_daq.h:270
-
PsiMsDaq_AccessFct_t::regWrite
PsiMsDaq_RegWrite_f * regWrite
Register write function to use.
Definition: psi_ms_daq.h:271
-
PsiMsDaq_StrHandle
void * PsiMsDaq_StrHandle
Handle to a specific stream of the driver.
Definition: psi_ms_daq.h:181
+
PsiMsDaq_WinInfo_t::ipHandle
PsiMsDaq_IpHandle ipHandle
Handle of the IP the window belongs to.
Definition: psi_ms_daq.h:226
+
PsiMsDaq_AccessFct_t::dataCopy
PsiMsDaq_DataCopy_f * dataCopy
Data copy function to use.
Definition: psi_ms_daq.h:280
+
PsiMsDaq_AccessFct_t::regWrite
PsiMsDaq_RegWrite_f * regWrite
Register write function to use.
Definition: psi_ms_daq.h:281
+
PsiMsDaq_StrHandle
void * PsiMsDaq_StrHandle
Handle to a specific stream of the driver.
Definition: psi_ms_daq.h:191
PsiMsDaq_RegWrite
PsiMsDaq_RetCode_t PsiMsDaq_RegWrite(PsiMsDaq_IpHandle ipHandle, const uint32_t addr, const uint32_t value)
Write to a register.
-
PsiMsDaq_StrConfig_t::winSize
uint32_t winSize
Size of the windows.
Definition: psi_ms_daq.h:262
-
PsiMsDaq_StrConfig_t::recMode
PsiMsDaq_RecMode_t recMode
Recording mode.
Definition: psi_ms_daq.h:257
+
PsiMsDaq_StrConfig_t::winSize
uint32_t winSize
Size of the windows.
Definition: psi_ms_daq.h:272
+
PsiMsDaq_StrConfig_t::recMode
PsiMsDaq_RecMode_t recMode
Recording mode.
Definition: psi_ms_daq.h:267
PsiMsDaq_Str_SetIrqEnable
PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqEnable(PsiMsDaq_StrHandle strHndl, const bool irqEna)
Enable/Disable IRQ for a stream.
PsiMsDaq_Str_Arm
PsiMsDaq_RetCode_t PsiMsDaq_Str_Arm(PsiMsDaq_StrHandle strHndl)
Arm the recorder for a given stream.
-
PsiMsDaq_StrConfig_t::winAsRingbuf
bool winAsRingbuf
Use individual windows as ring-buffers (true=ringbuffer mode, false=linear mode)
Definition: psi_ms_daq.h:258
-
PsiMsDaq_WinInfo_t
Window definition struct, used for more compact passing of common parameters.
Definition: psi_ms_daq.h:214
+
PsiMsDaq_StrConfig_t::winAsRingbuf
bool winAsRingbuf
Use individual windows as ring-buffers (true=ringbuffer mode, false=linear mode)
Definition: psi_ms_daq.h:268
+
PsiMsDaq_WinInfo_t
Window definition struct, used for more compact passing of common parameters.
Definition: psi_ms_daq.h:224
PsiMsDaq_Str_GetIpHandle
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetIpHandle(PsiMsDaq_StrHandle strHndl, PsiMsDaq_IpHandle *ipHandle_p)
Get the IP Handle of the IP a stream belongs to.
-
PsiMsDaq_RecMode_t
PsiMsDaq_RecMode_t
Recorder mode (see documentation)
Definition: psi_ms_daq.h:245
-
PsiMsDaq_StrConfig_t::bufStartAddr
uint32_t bufStartAddr
Start address of the buffer for this stream.
Definition: psi_ms_daq.h:261
+
PsiMsDaq_RecMode_t
PsiMsDaq_RecMode_t
Recorder mode (see documentation)
Definition: psi_ms_daq.h:255
+
PsiMsDaq_StrConfig_t::bufStartAddr
uint32_t bufStartAddr
Start address of the buffer for this stream.
Definition: psi_ms_daq.h:271
PsiMsDaq_RegSetBit
PsiMsDaq_RetCode_t PsiMsDaq_RegSetBit(PsiMsDaq_IpHandle ipHandle, const uint32_t addr, const uint32_t mask, const bool value)
Set a bit in a register (RMW)
PsiMsDaq_Str_SetIrqCallbackStr
PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqCallbackStr(PsiMsDaq_StrHandle strHndl, PsiMsDaqn_StrIrq_f *irqCb, void *arg_p)
Set stream based interrupt callback function for a stream to be called whenever a new windows is reco...
-
PsiMsDaq_IpHandle
void * PsiMsDaq_IpHandle
Handle to an instance of the driver for a complete IP.
Definition: psi_ms_daq.h:180
+
PsiMsDaq_IpHandle
void * PsiMsDaq_IpHandle
Handle to an instance of the driver for a complete IP.
Definition: psi_ms_daq.h:190
PsiMsDaq_RegGetField
PsiMsDaq_RetCode_t PsiMsDaq_RegGetField(PsiMsDaq_IpHandle ipHandle, const uint32_t addr, const uint8_t lsb, const uint8_t msb, uint32_t *const value_p)
Read a field from a register.
PsiMsDaq_Str_CurrentWin
PsiMsDaq_RetCode_t PsiMsDaq_Str_CurrentWin(PsiMsDaq_StrHandle strHndl, uint8_t *const currentWin_p)
Get the currently used recorder window.
-
PsiMsDaq_RetCode_MorePostTrigThanConfigured
More post trigger data requested than configured to be recorded.
Definition: psi_ms_daq.h:287
-
PsiMsDaq_RegWrite_f
void PsiMsDaq_RegWrite_f(const uint32_t addr, const uint32_t value)
Write an IP-register.
Definition: psi_ms_daq.h:199
-
PsiMsDaq_RetCode_IllegalWinNr
Illegal window number passed.
Definition: psi_ms_daq.h:284
-
PsiMsDaq_RegRead_f
uint32_t PsiMsDaq_RegRead_f(const uint32_t addr)
Read an IP-register.
Definition: psi_ms_daq.h:207
-
PsiMsDaqn_WinIrq_f
void PsiMsDaqn_WinIrq_f(PsiMsDaq_WinInfo_t winInfo, void *arg)
Interrupt callback function for the window based IRQ scheme. In this IRQ scheme, one callback functio...
Definition: psi_ms_daq.h:229
-
PsiMsDaq_RetCode_StrNotDisabled
This function is only allowed if the stream is disbled but it was enabled.
Definition: psi_ms_daq.h:282
-
PsiMsDaq_AccessFct_t::regRead
PsiMsDaq_RegRead_f * regRead
Register read function to use.
Definition: psi_ms_daq.h:272
-
PsiMsDaq_DataCopy_f
void PsiMsDaq_DataCopy_f(void *dst, void *src, size_t n)
Copy used to copy data recorded to other memory locations in PsiMsDaq_StrWin_GetDataUnwrapped() ...
Definition: psi_ms_daq.h:191
-
PsiMsDaq_AccessFct_t
Memory access functions struct.
Definition: psi_ms_daq.h:269
+
PsiMsDaq_RetCode_MorePostTrigThanConfigured
More post trigger data requested than configured to be recorded.
Definition: psi_ms_daq.h:297
+
PsiMsDaq_RegWrite_f
void PsiMsDaq_RegWrite_f(const uint32_t addr, const uint32_t value)
Write an IP-register.
Definition: psi_ms_daq.h:209
+
PsiMsDaq_RetCode_IllegalWinNr
Illegal window number passed.
Definition: psi_ms_daq.h:294
+
PsiMsDaq_RegRead_f
uint32_t PsiMsDaq_RegRead_f(const uint32_t addr)
Read an IP-register.
Definition: psi_ms_daq.h:217
+
PsiMsDaqn_WinIrq_f
void PsiMsDaqn_WinIrq_f(PsiMsDaq_WinInfo_t winInfo, void *arg)
Interrupt callback function for the window based IRQ scheme. In this IRQ scheme, one callback functio...
Definition: psi_ms_daq.h:239
+
PsiMsDaq_RetCode_StrNotDisabled
This function is only allowed if the stream is disbled but it was enabled.
Definition: psi_ms_daq.h:292
+
PsiMsDaq_AccessFct_t::regRead
PsiMsDaq_RegRead_f * regRead
Register read function to use.
Definition: psi_ms_daq.h:282
+
PsiMsDaq_DataCopy_f
void PsiMsDaq_DataCopy_f(void *dst, void *src, size_t n)
Copy used to copy data recorded to other memory locations in PsiMsDaq_StrWin_GetDataUnwrapped() ...
Definition: psi_ms_daq.h:201
+
PsiMsDaq_AccessFct_t
Memory access functions struct.
Definition: psi_ms_daq.h:279
PsiMsDaq_Str_GetLastWrittenWin
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetLastWrittenWin(PsiMsDaq_StrHandle strHndl, uint8_t *const lastWrittenWin_p)
Get the number of the last window that was written to memory completely.
-
PsiMsDaqn_RecMode_SingleShot
Only record pre-trigger after PsiMsDaq_Str_Arm() was called and stop recording after one trigger...
Definition: psi_ms_daq.h:248
+
PsiMsDaqn_RecMode_SingleShot
Only record pre-trigger after PsiMsDaq_Str_Arm() was called and stop recording after one trigger...
Definition: psi_ms_daq.h:258
PsiMsDaq_Str_CurrentPtr
PsiMsDaq_RetCode_t PsiMsDaq_Str_CurrentPtr(PsiMsDaq_StrHandle strHndl, uint32_t *const currentPtr_p)
Get the current write pointer of the recording logic.
PsiMsDaq_StrWin_GetNoOfBytes
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetNoOfBytes(PsiMsDaq_WinInfo_t winInfo, uint32_t *const noOfBytes_p)
Get number of valid and unacknowledged bytes in a window.
-
PsiMsDaq_RetCode_Success
No error, everything OK.
Definition: psi_ms_daq.h:279
+
PsiMsDaq_RetCode_Success
No error, everything OK.
Definition: psi_ms_daq.h:289
PsiMsDaq_StrWin_GetPreTrigSamples
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetPreTrigSamples(PsiMsDaq_WinInfo_t winInfo, uint32_t *const preTrigSamples_p)
Get the number of pre-trigger samples in a window (post trigger samples are known by config) ...
PsiMsDaq_RegGetBit
PsiMsDaq_RetCode_t PsiMsDaq_RegGetBit(PsiMsDaq_IpHandle ipHandle, const uint32_t addr, const uint32_t mask, bool *const value_p)
Read a bit from a register.
-
PsiMsDaq_RetCode_WinSizeMustBeMultipleOfSamples
Window size must be a multiple of the sample size.
Definition: psi_ms_daq.h:289
-
PsiMsDaqn_StrIrq_f
void PsiMsDaqn_StrIrq_f(PsiMsDaq_StrHandle strHandle, void *arg)
Interrupt callback function for the stream based IRQ scheme. In this IRQ scheme, one callback functio...
Definition: psi_ms_daq.h:240
-
PsiMsDaq_RetCode_IrqSchemesWinAndStrAreExclusive
Only one IRQ scheme (...Str or ...Win) can be used.
Definition: psi_ms_daq.h:290
-
PsiMsDaq_RetCode_MorePreTrigThanAvailable
More pre-trigger data requested than available.
Definition: psi_ms_daq.h:288
-
PsiMsDaq_RetCode_NoTrigInWin
This window does not contain a trigger as required for this function call.
Definition: psi_ms_daq.h:285
+
PsiMsDaq_RetCode_WinSizeMustBeMultipleOfSamples
Window size must be a multiple of the sample size.
Definition: psi_ms_daq.h:299
+
PsiMsDaqn_StrIrq_f
void PsiMsDaqn_StrIrq_f(PsiMsDaq_StrHandle strHandle, void *arg)
Interrupt callback function for the stream based IRQ scheme. In this IRQ scheme, one callback functio...
Definition: psi_ms_daq.h:250
+
PsiMsDaq_RetCode_IrqSchemesWinAndStrAreExclusive
Only one IRQ scheme (...Str or ...Win) can be used.
Definition: psi_ms_daq.h:300
+
PsiMsDaq_RetCode_MorePreTrigThanAvailable
More pre-trigger data requested than available.
Definition: psi_ms_daq.h:298
+
PsiMsDaq_RetCode_NoTrigInWin
This window does not contain a trigger as required for this function call.
Definition: psi_ms_daq.h:295
PsiMsDaq_Str_SetEnable
PsiMsDaq_RetCode_t PsiMsDaq_Str_SetEnable(PsiMsDaq_StrHandle strHndl, const bool enable)
Enable/Disable a stream.
PsiMsDaq_HandleIrq
void PsiMsDaq_HandleIrq(PsiMsDaq_IpHandle inst_p)
-
PsiMsDaq_RetCode_t
PsiMsDaq_RetCode_t
Return codes.
Definition: psi_ms_daq.h:278
+
PsiMsDaq_RetCode_t
PsiMsDaq_RetCode_t
Return codes.
Definition: psi_ms_daq.h:288
PsiMsDaq_Str_Configure
PsiMsDaq_RetCode_t PsiMsDaq_Str_Configure(PsiMsDaq_StrHandle strHndl, PsiMsDaq_StrConfig_t *const config_p)
Configure stream.
PsiMsDaq_Str_GetStrNr
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetStrNr(PsiMsDaq_StrHandle strHndl, uint8_t *strNr_p)
Get the stream number from a stream handle.
PsiMsDaq_Str_GetMaxLvl
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetMaxLvl(PsiMsDaq_StrHandle strHndl, uint32_t *const maxLvl_p)
Get maximum input buffer fill level.
PsiMsDaq_StrWin_GetLastSplAddr
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetLastSplAddr(PsiMsDaq_WinInfo_t winInfo, uint32_t *const lastSplAddr_p)
Get the address of the last sample (not byte) written into a window.
-
PsiMsDaq_StrConfig_t
Stream configuration struct.
Definition: psi_ms_daq.h:255
+
PsiMsDaq_StrConfig_t
Stream configuration struct.
Definition: psi_ms_daq.h:265
PsiMsDaq_RegSetField
PsiMsDaq_RetCode_t PsiMsDaq_RegSetField(PsiMsDaq_IpHandle ipHandle, const uint32_t addr, const uint8_t lsb, const uint8_t msb, const uint32_t value)
Set a field in a register (RMW)
PsiMsDaq_Str_GetFreeWindows
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetFreeWindows(PsiMsDaq_StrHandle strHndl, uint8_t *const freeWindows_p)
Get the number of free windows.
PsiMsDaq_GetStrHandle
PsiMsDaq_RetCode_t PsiMsDaq_GetStrHandle(PsiMsDaq_IpHandle ipHandle, const uint8_t streamNr, PsiMsDaq_StrHandle *const strHndl_p)
Get a handle to a specific stream number.
-
PsiMsDaq_WinInfo_t::strHandle
PsiMsDaq_StrHandle strHandle
Handle of the stream the window belongs to.
Definition: psi_ms_daq.h:217
+
PsiMsDaq_WinInfo_t::strHandle
PsiMsDaq_StrHandle strHandle
Handle of the stream the window belongs to.
Definition: psi_ms_daq.h:227
PsiMsDaq_Str_GetTotalWindows
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetTotalWindows(PsiMsDaq_StrHandle strHndl, uint8_t *const windows_p)
Get the number of windows configured to be used for a given stream.
PsiMsDaq_StrWin_GetNoOfSamples
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetNoOfSamples(PsiMsDaq_WinInfo_t winInfo, uint32_t *const noOfSamples_p)
Get number of valid and unacknowledged samples in a window.
PsiMsDaq_Str_SetIrqCallbackWin
PsiMsDaq_RetCode_t PsiMsDaq_Str_SetIrqCallbackWin(PsiMsDaq_StrHandle strHndl, PsiMsDaqn_WinIrq_f *irqCb, void *arg_p)
Set window based interrupt callback function for a stream to be called whenever a new windows is reco...
PsiMsDaq_Str_GetUsedWindows
PsiMsDaq_RetCode_t PsiMsDaq_Str_GetUsedWindows(PsiMsDaq_StrHandle strHndl, uint8_t *const usedWindows_p)
Get the number of used (non-free) windows.
-
PsiMsDaq_RetCode_IllegalStrNr
Illegal stream number passed.
Definition: psi_ms_daq.h:280
-
PsiMsDaq_StrConfig_t::streamWidthBits
uint16_t streamWidthBits
Width od the stream in bits (must be a multiple of 8)
Definition: psi_ms_daq.h:263
+
PsiMsDaq_RetCode_IllegalStrNr
Illegal stream number passed.
Definition: psi_ms_daq.h:290
+
PsiMsDaq_StrConfig_t::streamWidthBits
uint16_t streamWidthBits
Width od the stream in bits (must be a multiple of 8)
Definition: psi_ms_daq.h:273
PsiMsDaq_Init
PsiMsDaq_IpHandle PsiMsDaq_Init(const uint32_t baseAddr, const uint8_t maxStreams, const uint8_t maxWindows, const PsiMsDaq_AccessFct_t *const accessFct_p)
Initialize the psi_ms_daq IP-Core.
-
PsiMsDaq_StrConfig_t::winCnt
uint8_t winCnt
Number of windows to use.
Definition: psi_ms_daq.h:260
-
PsiMsDaqn_RecMode_TriggerMask
Continuously record pre-trigger data but only detect triggers after PsiMsDaq_Str_Arm() was called...
Definition: psi_ms_daq.h:247
-
PsiMsDaqn_RecMode_Manual
Manaully control the recording by setting and clearing the arm bit.
Definition: psi_ms_daq.h:249
-
PsiMsDaq_StrConfig_t::winOverwrite
bool winOverwrite
If true, windows are overwritten even if they contain data. Usually set false here.
Definition: psi_ms_daq.h:259
-
PsiMsDaq_RetCode_BufferTooSmall
The buffer passed is too small to contain all data.
Definition: psi_ms_daq.h:286
+
PsiMsDaq_StrConfig_t::winCnt
uint8_t winCnt
Number of windows to use.
Definition: psi_ms_daq.h:270
+
PsiMsDaqn_RecMode_TriggerMask
Continuously record pre-trigger data but only detect triggers after PsiMsDaq_Str_Arm() was called...
Definition: psi_ms_daq.h:257
+
PsiMsDaqn_RecMode_Manual
Manaully control the recording by setting and clearing the arm bit.
Definition: psi_ms_daq.h:259
+
PsiMsDaq_StrConfig_t::winOverwrite
bool winOverwrite
If true, windows are overwritten even if they contain data. Usually set false here.
Definition: psi_ms_daq.h:269
+
PsiMsDaq_RetCode_BufferTooSmall
The buffer passed is too small to contain all data.
Definition: psi_ms_daq.h:296
PsiMsDaq_RegRead
PsiMsDaq_RetCode_t PsiMsDaq_RegRead(PsiMsDaq_IpHandle ipHandle, const uint32_t addr, uint32_t *const value_p)
Read a register.
PsiMsDaq_Str_IsRecording
PsiMsDaq_RetCode_t PsiMsDaq_Str_IsRecording(PsiMsDaq_StrHandle strHndl, bool *const isRecording_p)
Check if the recorder of a given stream is currently recording data.
-
PsiMsDaqn_RecMode_Continuous
Continuous recording.
Definition: psi_ms_daq.h:246
-
PsiMsDaq_RetCode_IllegalWinCnt
Illegal window count passed.
Definition: psi_ms_daq.h:283
-
PsiMsDaq_StrConfig_t::postTrigSamples
uint32_t postTrigSamples
Number of post trigger samples (incl. Trigger sample)
Definition: psi_ms_daq.h:256
-
PsiMsDaq_WinInfo_t::winNr
uint8_t winNr
Window number.
Definition: psi_ms_daq.h:215
+
PsiMsDaqn_RecMode_Continuous
Continuous recording.
Definition: psi_ms_daq.h:256
+
PsiMsDaq_RetCode_IllegalWinCnt
Illegal window count passed.
Definition: psi_ms_daq.h:293
+
PsiMsDaq_StrConfig_t::postTrigSamples
uint32_t postTrigSamples
Number of post trigger samples (incl. Trigger sample)
Definition: psi_ms_daq.h:266
+
PsiMsDaq_WinInfo_t::winNr
uint8_t winNr
Window number.
Definition: psi_ms_daq.h:225
PsiMsDaq_StrWin_MarkAsFree
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_MarkAsFree(PsiMsDaq_WinInfo_t winInfo)
Mark a window as free so it can receive new data. This function must be called after the window data ...
PsiMsDaq_StrWin_GetTimestamp
PsiMsDaq_RetCode_t PsiMsDaq_StrWin_GetTimestamp(PsiMsDaq_WinInfo_t winInfo, uint64_t *const timestamp_p)
Get the timestamp of a window.
diff --git a/doc/api/html/struct_psi_ms_daq___access_fct__t.html b/doc/api/html/struct_psi_ms_daq___access_fct__t.html index 3efbf66..2de31b7 100644 --- a/doc/api/html/struct_psi_ms_daq___access_fct__t.html +++ b/doc/api/html/struct_psi_ms_daq___access_fct__t.html @@ -160,7 +160,7 @@ Public Attributes
The documentation for this struct was generated from the following file: diff --git a/doc/api/html/struct_psi_ms_daq___str_config__t.html b/doc/api/html/struct_psi_ms_daq___str_config__t.html index 6bbee10..7afb393 100644 --- a/doc/api/html/struct_psi_ms_daq___str_config__t.html +++ b/doc/api/html/struct_psi_ms_daq___str_config__t.html @@ -255,7 +255,7 @@ Public Attributes
The documentation for this struct was generated from the following file: diff --git a/doc/api/html/struct_psi_ms_daq___win_info__t.html b/doc/api/html/struct_psi_ms_daq___win_info__t.html index df939c4..b856db9 100644 --- a/doc/api/html/struct_psi_ms_daq___win_info__t.html +++ b/doc/api/html/struct_psi_ms_daq___win_info__t.html @@ -161,7 +161,7 @@ Public Attributes
The documentation for this struct was generated from the following file: diff --git a/driver/psi_ms_daq.h b/driver/psi_ms_daq.h index 0097325..4be0e53 100644 --- a/driver/psi_ms_daq.h +++ b/driver/psi_ms_daq.h @@ -117,13 +117,13 @@ extern "C" { * .winSize = , //in bytes * .streamWidthBits = * }; -* PsiMsDaq_Str_Configure(daqHandle, &cfg); +* PsiMsDaq_Str_Configure(daqStrHandle, &cfg); * //Register ballback -* PsiMsDaq_Str_SetIrqCallbackWin(daqHandle, UserDaqIsr, NULL); +* PsiMsDaq_Str_SetIrqCallbackWin(daqStrHandle, UserDaqIsr, NULL); * //Enable IRQ -* PsiMsDaq_Str_SetIrqEnable(daqHandle, true); +* PsiMsDaq_Str_SetIrqEnable(daqStrHandle, true); * //Enable recorder for stream -* PsiMsDaq_Str_SetEnable(daqHandle, true); +* PsiMsDaq_Str_SetEnable(daqStrHandle, true); * * //Wait in endless loop for IRQs comming in * while(1){};