iosys.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_IOSYS_H
#define _NB_IOSYS_H
 
#ifndef _CONSTANTS_H
#include <constants.h>
#endif
 
#include <stdio.h>
 
#ifndef _BASICTYPES_H_
#include <basictypes.h>
#endif
 
class TickTimeout;
#ifdef __cplusplus
extern "C"
{
#endif
 
    int close(int fd);
 
    int read(int fd, char *buf, int nbytes);
 
    int peek(int fd, char *c);
 
    int write(int fd, const char *buf, int nbytes);
 
    int writestring(int fd, const char *str);
 
    int writeall(int fd, const char *buf, int nbytes = 0);
 
    int ReadWithTimeout(int fd, char *buf, int nbytes, unsigned long timeout);
 
    int ReadWithTickTimeout(int fd, char *buf, int nbytes, TickTimeout &timeout);
 
    int ReadAllWithTimeout(int fd, char *buf, int nbytes, unsigned long timeout);
 
    int ReadAllWithTickTimeout(int fd, char *buf, int nbytes, TickTimeout &timeout);
 
    int readall(int fd, char *buf, int nbytes);
 
    int PeekWithTimeout(int fd, char *c, unsigned long timeout);
 
    int getchar();
 
    int dataavail(int fd);
 
    int writeavail(int fd);
 
    int haserror(int fd);
 
    int charavail();
 
#ifdef fd_set
#undef fd_set
#endif
 
#ifdef FD_ZERO
#undef FD_ZERO
#endif
 
#ifdef FD_CLR
#undef FD_CLR
#endif
 
#ifdef FD_SET
#undef FD_SET
#endif
 
#ifdef FD_ISSET
#undef FD_ISSET
#endif
 
#ifdef FD_SETSIZE
#undef FD_SETSIZE
#endif
 
#define FD_SETSIZE (FDSET_ELEMENTS * 32)
 
    class OS_SEM;
 
    typedef struct
    {
        uint32_t fd_set_elements[FDSET_ELEMENTS];
    } __attribute__((packed)) fd_set;
 
    enum FDChangeType
    {
        eReadSet,    
        eWriteSet,   
        eErrorSet,   
        eClosingNow  
    };
    typedef void FDCallBack(int fd, FDChangeType change, void *pData);
 
    void RegisterFDCallBack(int fd, FDCallBack *fp, void *pData);
 
    void FD_ZERO(fd_set *pfds);
 
    void FD_CLR(int fd, fd_set *pfds);
 
    void FD_SET(int fd, fd_set *pfds);
 
    int FD_ISSET(int fd, fd_set *pfds);
 
    int FD_OVERLAP(const fd_set *f1, const fd_set *f2);
 
    void FD_COPY(const fd_set *from, fd_set *to);
 
    void FD_SETFROMSET(const fd_set *from, fd_set *to);
 
    void FD_CLRFROMSET(const fd_set *from, fd_set *to);
 
    // A Select that uses an external SEM so other things can wake it up.
    int extern_sem_select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *errorfds, OS_SEM &sem, unsigned long timeout);
 
    int textern_sem_select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *errorfds, OS_SEM &sem, TickTimeout &timeout);
 
    int select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *errorfds, unsigned long timeout);
 
    int tselect(int nfds, fd_set *readfds, fd_set *writefds, fd_set *errorfds, TickTimeout &timeout);
 
    int ZeroWaitSelect(int nfds, fd_set *readfds, fd_set *writefds, fd_set *errorfds);
 
/**********************************************************************/
/*   Define sets of flags to pass to the ioctl function               */
/**********************************************************************/
 
#define IOCTL_TX_CHANGE_CRLF (1)     
#define IOCTL_RX_CHANGE_CRLF (2)     
#define IOCTL_RX_PROCESS_EDITS (4)   
#define IOCTL_RX_ECHO (8)            
#define IOCTL_TX_NO_BLOCK (32)       
#define IOCTL_ALL_OPTIONS (15)       
#define IOCTL_SET (0x4000)   
#define IOCTL_CLR (0x2000)   
    int ioctl(int fd, int cmd);
 
    int ReplaceStdio(int stdio_fd, int new_fd);
 
    int CurrentStdioFD(int stdio_fd);
 
    void IrqStdio();
 
#ifdef __cplusplus
}
#endif
 
#endif
 
   // groupIOSYS