ngcdrv.h

Go to the documentation of this file.

#ifndef NGCDRV_H
#define NGCDRV_H
/*******************************************************************************
* E.S.O. - European Southern Observatory
*
* "@(#) $Id: ngcdrv.h 354209 2022-03-29 10:19:20Z jstegmei $"
*
* who       when        what
* --------  ----------  ----------------------------------------------
* jstegmei  2005-02-16  created
* jstegmei  2009-03-10  added NGCDRV_GETREV ioctl
* jstegmei  2009-03-10  increased COM-FIFO size
* jstegmei  2010-12-02  added NGCDRV_RESET ioctl
* jstegmei  2010-12-22  added comments
* jstegmei  2011-02-08  added NGCDRV_COM_STATUS
* jstegmei  2011-02-08  replaced NGCDRV_DMA_HDR_SET with NGCDRV_DMA_CHAN
* jstegmei  2011-04-07  added comments
* jstegmei  2011-04-13  added comments
* jstegmei  2011-05-11  added NGCDRV_DMA_IPP_MODE ioctl
* jstegmei  2011-05-23  added NGCDRV_DMA_IPP_CFG ioctl
* jstegmei  2012-07-30  changed unsigned long types to unsigned int
* jstegmei  2013-03-21  added reserved word to ngcdrv_param_t structure for
*                       64-bit alignment
*/
 
/************************************************************************
 *
 *  ngcdrv.h - NGC driver interface
 *
 *----------------------------------------------------------------------
 */
 
 
#ifdef  __cplusplus
extern "C" {
#endif

#define NGCDRV_VERSION 0x1

#define NGCDRV_COM_FIFO_SIZE 1024

#define NGCDRV_CTRL_SYSHDR 0x00000008   

#define NGCDRV_CTRL_SYSRESET 0x00008000

#define NGCDRV_CTRL_MAXHDR 0x00000008     
 
/* 
 * Status register values and masks 
 */
#define NGCDRV_STAT_ACK          0x00000001  
#define NGCDRV_STAT_VALID        0x00000002  
#define NGCDRV_STAT_DMA_EMPTY    0x00000020  
#define NGCDRV_STAT_DMA_FULL     0x00000040  
#define NGCDRV_STAT_DMA_OVERFLOW 0x00000080  
#define NGCDRV_STAT_RX_EMPTY     0x00000100  
#define NGCDRV_STAT_RX_FULL      0x00000200  
#define NGCDRV_STAT_TX_EMPTY     0x00000400  
#define NGCDRV_STAT_TX_FULL      0x00000800  
#define NGCDRV_STAT_LINK_UP      0x00001000  
#define NGCDRV_STAT_HARD_ERR     0x00002000 
#define NGCDRV_STAT_SOFT_ERR     0x00004000  
#define NGCDRV_STAT_FRAM_ERR     0x00008000  

typedef struct {
  int nbuf;           
  unsigned int size;  
} ngcdrv_ring_t;

typedef struct {
  unsigned int reg;       
  unsigned int val;       
  unsigned int off;       
  unsigned int reserved;  
} ngcdrv_param_t;
 
/*
 * Interrupt post-processor modes
 */
#define NGCDRV_IPP_NONE    0x00000000  
#define NGCDRV_IPP_TASKLET 0x00000001  
#define NGCDRV_IPP_WQ      0x00000002  
#define NGCDRV_IPP_IRQ     0x00000003  

#define NGCDRV_MAX_PARAM 32 

typedef struct {
  int taskId;                   
  int param[NGCDRV_MAX_PARAM];  
} ngcdrv_tcb_cfg;

enum ngcdrv_ioctl {
  NGCDRV_D_COM_STATUS,
  NGCDRV_D_COM_UPLINK,
  NGCDRV_D_COM_RESET,
  NGCDRV_D_COM_TMO,
  NGCDRV_D_DMA_RESERVED1,
  NGCDRV_D_DMA_RESERVED2,
  NGCDRV_D_DMA_RESET,
  NGCDRV_D_DMA_START,
  NGCDRV_D_DMA_WAIT,
  NGCDRV_D_DMA_ABORT,
  NGCDRV_D_DMA_DONECOUNT,
  NGCDRV_D_DMA_BYTECOUNT,
  NGCDRV_D_DMA_OVERFLOW,
  NGCDRV_D_DMA_CFG_BUF,
  NGCDRV_D_DMA_IPP_MODE,
  NGCDRV_D_DMA_IPP_CFG,
  NGCDRV_D_DMA_CHAN,
  NGCDRV_D_CFG_GET,
  NGCDRV_D_CFG_SET,
  NGCDRV_D_PCFG_GET,
  NGCDRV_D_PCFG_SET,
  NGCDRV_D_GETREV,
  NGCDRV_D_RESET,
  NGCDRV_D_DMA_SYNCMODE
};
 
/* 
 * ioctl's for communication port 
 */
#define NGCDRV_COM_STATUS     _IOR('I', (NGCDRV_D_COM_STATUS), unsigned int)
#define NGCDRV_COM_UPLINK     _IOW('I', (NGCDRV_D_COM_UPLINK), unsigned int)
#define NGCDRV_COM_RESET      _IO('I', (NGCDRV_D_COM_RESET))
#define NGCDRV_COM_TMO        _IOW('I', (NGCDRV_D_COM_TMO), unsigned int)
 
/* 
 * ioctl's for DMA interface
 */
#define NGCDRV_DMA_RESET      _IO('I', (NGCDRV_D_DMA_RESET))
#define NGCDRV_DMA_START      _IO('I', (NGCDRV_D_DMA_START))
#define NGCDRV_DMA_WAIT       _IO('I', (NGCDRV_D_DMA_WAIT))
#define NGCDRV_DMA_ABORT      _IO('I', (NGCDRV_D_DMA_ABORT))
#define NGCDRV_DMA_DONECOUNT  _IOR('I', (NGCDRV_D_DMA_DONECOUNT), unsigned int)
#define NGCDRV_DMA_BYTECOUNT  _IOR('I', (NGCDRV_D_DMA_BYTECOUNT), unsigned int)
#define NGCDRV_DMA_OVERFLOW   _IOR('I', (NGCDRV_D_DMA_OVERFLOW), unsigned int)
#define NGCDRV_DMA_CFG_BUF    _IOR('I', (NGCDRV_D_DMA_CFG_BUF), ngcdrv_ring_t) 
#define NGCDRV_DMA_IPP_MODE   _IOW('I', (NGCDRV_D_DMA_IPP_MODE), unsigned int)
#define NGCDRV_DMA_IPP_CFG    _IOW('I', (NGCDRV_D_DMA_IPP_CFG), ngcdrv_tcb_cfg)
#define NGCDRV_DMA_CHAN       _IOW('I', (NGCDRV_D_DMA_CHAN), unsigned int)
#define NGCDRV_DMA_SYNCMODE   _IOW('I', (NGCDRV_D_DMA_SYNCMODE), unsigned int)
 
/* 
 * General ioctl's 
 */
#define NGCDRV_CFG_GET        _IOR('I', (NGCDRV_D_CFG_GET), ngcdrv_param_t)
#define NGCDRV_CFG_SET        _IOW('I', (NGCDRV_D_CFG_SET), ngcdrv_param_t)
#define NGCDRV_PCFG_GET       _IOR('I', (NGCDRV_D_PCFG_SET), ngcdrv_param_t)
#define NGCDRV_PCFG_SET       _IOW('I', (NGCDRV_D_PCFG_SET), ngcdrv_param_t)
#define NGCDRV_GETREV         _IOR('I', (NGCDRV_D_GETREV), unsigned int)
#define NGCDRV_RESET          _IO('I', (NGCDRV_D_RESET))

typedef struct {
  int param1;  
  int param2;  
  int param3;  
} ngcdrv_tcb_test;

typedef struct {
  int n;  
} ngcdrv_tcb_add;

typedef struct {
  int ndit;  
  int n;     
} ngcdrv_tcb_fowler;
 
 
#ifdef  __cplusplus
}
#endif
 
#endif /* !NGCDRV_H */