DRIVER AND LIBRARY FOR DB67 DSP BOARD DRIVER AND LIBRARY FOR DB67 DSP BOARD

Transcription

1 DRIVER AND LIBRARY FOR DB67 DSP BOARD

2 G.Petrosyan MVP, DESY (Hamburg, Germany), ErPhi (Erevan, Armenia) K. Rehlich DESY (Hamburg, Germany) P.Vetrov DESY (Hamburg, Germany),

3 DRIVER The basic part of LLRF DSP control system is 6U-VME standard DSP board which contains TMS320C6701 floating-point DSP (Texas Instruments Inc.) and 8 Gigalink channels [1]. For effective usage of this board the driver for OS Solaris 2 was written. Additionally a bootable program was developed which is stored in the flash memory of the DSP board. On start up or reset this program initializes the DSP internal registers and DSP Interrupt Service Table (IST) [2]. After this initialization the program enters an idle loop. Init Internal registers Init IST IDLE xxxxx Since the idle loop instructions are arranged in reserved memory space, which is not used for application programs, we can load an application program in to the DSP memory without disturb this loop. By changing the loop instructions from Host Port Interface (HPI) can force DSP to exit from loop. Before doing it we have to set required branch instruction at xxxxx. For example, if we want to start a new application program we have to set branch instruction to 0x200h address. As default the HPI Interrupt Service Instruction Fetch contains branch to this idle loop and it is possible organise application program s pause sending host interrupt to the DSP. To return to the application program s interrupted point we have to set at xxxxx branch instruction with IRP (Interrupt Return Pointer) argument and exit idle loop. The DSP driver is written as a DDI/DDK Loadable Driver for SYSTEM V (Solaris 2) and DSP board presented as a Character Device. The driver controls the DSP board and allows read/write data from/to DSP board memory including DSP internal memory. IOR, SR, VR, DSP-RESET, HPIC, HPIA, and HPID registers of DSP board are accessible from VME bus [1]. SR and VR registers are used for setting interrupt vector and interrupt level for DSP interrupt to Host. Writing into the DSP-RESET register causes the DSP board reset. HPIC, HPIA, and HPID registers are DSP Host Port Interface s registers which are used for to read/write data from/to DSP board memory including DSP internal memory. The driver has two modes of operation for interrupt handling: 1. Driver pauses itself for 6 ms and after this time continues its work. The delay of 6 ms is defined by processing time of the macro pulse of LLRF system. 2. If there are processes requested to be notified on some events, the driver will sent them system signal. This modes are set by system call ioctl(). Description of this call is presented. A user process can use open(), close(), write(), read() and ioctl() system calls for this driver. For easier programming a programmer can use our C++ library. Petrosyan Gevorg Page 3 07/02/2005

4 [1] VME DSP module with 8 GigaLink interfaces. [2] TMS320c6000 CPU and Instruction Set, ch. 8, Texas Instruments Inc. SPRU189E. Petrosyan Gevorg Page 4 07/02/2005

5 DESCRIPTION OF SYSTEM CALLS AND LIBRARY FUNCTION Petrosyan Gevorg Page 5 07/02/2005

6 SYSTEM CALL OPEN int open(char *path, int flags); Opens link-level device named in the path string, e.g. /dev/db67ff0. The flags argument is a bitmap selecting behaviour of the device. The following fields may be specified: O_RDONLY O_WRONLY O_RDWR Opens the board for read access only. Opens the board for write access only. Opens the board for read and write access. Only one of flags must be specified. Returns: and numand or Upon successful completion, the function opens the file return a non-negative integer representing the lowest bered unused file descriptor. Otherwise, -1 is returned errno is set to indicate the error. No files are created modified if the function returns -1. int fd = open ( /dev/db67ff0, O_RDWR); if( fd < 0) perror( open ); else printf( Device db67ff0 opened OK!\n ); Petrosyan Gevorg Page 6 07/02/2005

7 SYSTEM CALL CLOSE int close(int fd); Closes the link-level device so that no further can be performed on it. This frees the device s file descriptor which may be allocated to another device or file when another call to open() is made. Returns: Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error. if (close(fd) < 0) perror ( close ); else printf ( Device closed OK!\n ); Petrosyan Gevorg Page 7 07/02/2005

8 SYSTEM CALL READ int read(int fd, char *buf, int nbyte); This function used to read nbyte-4 bytes data from DSP bord via DSP HPI into the given buffer decrypted by pointer buf. Start address of data in DSP memory allocated in first 4 bytes of the buffer e.g. returned data will be placed in the buffer starting at fifth byte. Returns: Upon successful completion, read() return a non-negative integer indicating the number of bytes actually read. Otherwise, the functions return -1 and set errno to indicate the error. Examples: Read 4 bytes at address 0x8000F000 int n,data[2]; data[0] = 0x8000F000; if((n = read (fd, &data[0], 8))!= 8) perror( read ); else printf( %d bytes read from DSP OK!\n, n 4 ); Petrosyan Gevorg Page 8 07/02/2005

9 SYSTEM CALL WRITE Returns: Examples: int write(int fd, char *buf, int nbyte); This function used to write nbyte-4 bytes data from the given buffer decrypted by pointer buf into the DSP board via DSP HPI. Start address of data in DSP memory allocated in first 4 bytes of the buffer. Upon successful completion, write() return a non-negative integer indicating the number of bytes actually read. Otherwise, the functions return -1 and set errno to indicate the error. write 4 bytes at address 0x8000F000 int n,data[2]; data[0] = 0x8000F000; data[1] = 12345; if((n = write (fd, &data[0], 8))!= 8) perror( write ); else printf( %d bytes written into DSP OK!\n, n 4 ); Petrosyan Gevorg Page 9 07/02/2005

10 SYSTEM CALL IOCTL int ioctl(int fd, int request, int arg); This command allows the user to perform miscellaneous function in relation to the module driver specified by the file descriptor fd. The function to be performed is determined by the parameter request. The role of the arg parameter is dependent on which function is to be performed. Valid request functions are: DB67D_RESET Reset DSP board. DB67_INT Send interrupt to DSP. DB67_INT_FREE DB67_NO_INT Puts ban to sent interrupt from DSP to Host. DB67D_INFO Get information about DSP board. Information will be placed into t_board_info type structure which is defined in db67cmd.h. t_board_info board_data1; ioctl(brd,db67d_info,&board_data1); printf(" Board info \n address = %x\n interrupt type = %i\n interrupt vector = %x\n interrupt level = %i\n", board_data1.adr, board_data1.int_type, board_data1.int_vector, board_data1.int_number); DB67_LLRF_INT Set interrupt type for LLRF control. When driver received interrupt then it paused 6 us. Petrosyan Gevorg Page 10 07/02/2005

11 DB67_SIG_INT Set interrupt type for send signal to registered process. The command must be look like this: ioctl (brd, DB67_SIG_INT_DEL, &ioctl_data); ioctl_data is db67_ioctl_data type structure. struct db67_ioctl_data { u_short f_irqnr; int f_sigirq; u_int f_status; }; struct db67_ioctl_data ioctl_data; sigset_t mask; struct sigaction hdl; sigemptyset (&mask); sigaddset (&mask, SIGUSR1); sigprocmask (SIG_SETMASK, &mask, NULL); sigemptyset (&hdl.sa_mask); hdl.sa_flags = 0; hdl.sa_handler = signal_handler; sigaction(sigusr1, &hdl, NULL); sigprocmask (SIG_UNBLOCK, &mask, NULL); ioctl_data.f_irqnr = 0; ioctl_data.f_sigirq = SIGUSR1; ioctl_data.f_status = 0; ioctl (brd, DB67_SIG_INT, &ioctl_data); This command saves information into the driver and when driver receives interrupt from DSP sends SIGNAL described in db67_ioctl_data.f_sigirq to the registered process. DB67_SIG_INT_DEL Clear all interrupt (SIGNAL) requests for process sent this command. ioctl (brd, DB67_SIG_INT_DEL, &ioctl_data); Petrosyan Gevorg Page 11 07/02/2005

12 LIBRARY FUNCTION db67open int db67open(int a); This function adds a as char at end the string /dev/db67ff and calls the system call open() whit this argument. a can be 0,1,2,3 and it depend from conf file of driver. This function returns the value which returned from system call open(). Petrosyan Gevorg Page 12 07/02/2005

13 LIBRARY FUNCTION db67close argument. returned. int db67close(int fd) This function calls the system call close() with fd The returned value from system call close() will be Petrosyan Gevorg Page 13 07/02/2005

14 LIBRARY FUNCTION db67_write_data_int int db67_write_data_int(int fd, int data, int adr) This function used to write integer data type to the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data integer data type which will be written in the DSP memory. adr address of DSP memory where data will be written. Upon successful completion, db67_write_data_int returns 0. Otherwise, error number WR_D_INT_ERR defined in db67lib.h will be returned and errno is set to indicate the error from write() system call. #include db67lib.h int data1; int adr1=0x ; if(db67_write_data_int(fd, data1, adr1)!=0)perror( db67_write_data_int ); Petrosyan Gevorg Page 14 07/02/2005

15 LIBRARY FUNCTION db67_read_data_int int db67_read_data_int(int fd, int adr, int *data) This function used to read integer data type from the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data pointer of integer data type where data will be written. adr address of DSP memory from where data will be read. Upon successful completion, db67_read_data_int returns 0. Otherwise, error number RD_D_INT_ERR defined in db67lib.h will be returned and errno is set to indicate the error from read() system call. int data1; int adr1=0x ; if(db67_read_data_int(fd, adr1, &data1)!= 0)perror( db67_read_data_int ); Petrosyan Gevorg Page 15 07/02/2005

16 LIBRARY FUNCTION db67_write_data_float int db67_write_data_float(int fd, float data, int adr) This function used to write float data type to the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data float data type which will be written in the DSP memory. adr address of DSP memory where data will be written. Upon successful completion, db67_write_data_float returns 0. Otherwise, error number WR_D_FLT_ERR defined in db67lib.h will be returned and errno is set to indicate the error from write() system call. float data1; int adr1=0x ; if(db67_write_data_ float(fd, data1, adr1)!=0 )perror( db67_write_data_ float ); Petrosyan Gevorg Page 16 07/02/2005

17 LIBRARY FUNCTION db67_read_data_float int db67_read_data_float(int fd, int adr, float *data) This function used to read float data type from the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data pointer of float data type where data will be written. adr address of memory from where data will be read. Upon successful completion, db67_read_data_float returns 0. Otherwise, error number RD_D_FLT_ERR defined in db67lib.h will be returned and errno is set to indicate the error from read() system call. float data1; int adr1=0x ; if(db67_read_data_float(fd, adr1, &data1)!= 0)perror( db67_read_data_float ); Petrosyan Gevorg Page 17 07/02/2005

18 LIBRARY FUNCTION db67_write_table_int adr) int db67_write_table_int(int fd, int *data, int len, int This function used to write integer type data array to the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data pointer of integer data type array. len number of data which will be written. adr - start address of the DSP memory space where data array will be written. Upon successful completion, db67_write_data_float returns 0. Otherwise, error numbers defined in db67lib.h will be returned and errno is set to indicate the error from write() or calloc() system calls. Returned value from the function WR_T_INT_ERR CALLOC_ERR System call set errno write() Calloc() int x[100]; int adr1 = 0x80000; if(db67_write_table_int(&x, 100,adr1)!= 0) perror( db67_write_table_int ); Petrosyan Gevorg Page 18 07/02/2005

19 LIBRARY FUNCTION db67_write_table_float adr) int db67_write_table_float(int fd, float *data, int len, int This function used to write float type data array to the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data pointer of float type data array. len number of data which will be written. adr - start address of the DSP memory space where data array will be written. Upon successful completion, db67_write_table_float returns 0. Otherwise, error numbers defined in db67lib.h will be returned and errno is set to indicate the error from write() or calloc() system calls. Returned value from the function WR_T_FLT_ERR CALLOC_ERR System call set errno write() Calloc() int x[100]; int adr1 = 0x80000; if(db67_write_table_float(&x, 100,adr1)<0) perror( db67_write_table_float ); Petrosyan Gevorg Page 19 07/02/2005

20 LIBRARY FUNCTION db67_read_table_int adr) int db67_read_table_int(int fd, int *data, int len, int This function used to read integer type data array from the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data pointer of integer type data array. len number of data which will be read. adr - start address of the DSP memory space from where data array will be read. Upon successful completion, db67_read_table_int returns 0. Otherwise, error number RD_T_INT_ERR defined in db67lib.h will be returned and errno is set to indicate the error from read() system call. int x[100]; int adr1 = 0x80000; if(db67_read_table_int (brd,&x, 100,adr1)<0) perror( db67_read_table_int ); Petrosyan Gevorg Page 20 07/02/2005

21 LIBRARY FUNCTION db67_read_table-float adr) int db67_read_table_float(int brd, float *d1, int len, int This function used to read float type data array from the DSP board memory. fd DSP board s file descriptor returned by db67open(int a) function. data pointer of float data type array. len number of data which will be read. adr - start address of the DSP memory space from where data array will be read. Upon successful completion, db67_read_table_float returns 0. Otherwise, error number RD_T_FLT_ERR defined in db67lib.h will be returned and errno is set to indicate the error from read() system call. float x[100]; int adr1 = 0x80000; if(db67_read_table_float (fd, &x, 100,adr1)!=0 ) perror( db67_read_table_int ); Petrosyan Gevorg Page 21 07/02/2005

22 LIBRARY FUNCTION db67_prog_load int db67_prog_load(int fd, char file[80]) This function resets DSP board and loads compiled program into the DSP. fd DSP board s file descriptor returned by db67open(int a) function. file path to the executable coff file. Upon successful completion, db67_prog_load returns 0. Otherwise, error numbers defined in db67lib.h will be returned and errno is set to indicate the error from write(),open() or calloc() system calls. Returned value from the function WR_SYS_ERR CALLOC_ERR NO_FILE System call set errno write() Calloc() Open() if(db67_prog_load (fd, linac.out )!=0 ) perror( db67_prog_load ); Petrosyan Gevorg Page 22 07/02/2005

23 LIBRARY FUNCTION db67_pause int db67_pause( int fd ) This function paused program in DSP. Upon successful completion, db67_pause returns 0. Otherwise, error number defined in db67lib.h will be returned and errno is set to indicate the error from write(),read() or ioctl() system calls. Returned value from the function WR_T_INT_ERR RD_T_INT_ERR WR_D_INT_ERR IOCTL_ERR System call set errno write() read() write() ioctl() if(db67_pause ( fd )!=0 ) perror( db67_pause ); Petrosyan Gevorg Page 23 07/02/2005

24 LIBRARY FUNCTION db67_run int db67_run(int fd) If a program in DSP was paused the program runs from the paused point. If DSP board was reset then the DSP runs the instructions at address 0x200. Before calling this function one of functions db67_reset, db67_pause, db67_prog_load mast be called, otherwise the error PR_NO_STOP will be returned. Upon successful completion, db67_pause returns 0. Otherwise, error numbers defined in db67lib.h will be returned and errno is set to indicate the error from write() system call. Returned value from the function WR_T_INT_ERR PR_NO_STOP System call set errno write() if(db67_run ( fd )!=0 ) perror( db67_run ); Petrosyan Gevorg Page 24 07/02/2005

25 LIBRARY FUNCTION db67_reset int db67_reset(int fd ) This function reset DSP board. Upon successful completion, db67_pause returns 0. Otherwise, error number IOCTL_ERR defined in db67lib.h will be returned and errno is set to indicate the error from ioctl() system call. if(db67_reset ( fd )!=0 ) perror( db67_reset ); ******************************************************************** Petrosyan Gevorg Page 25 07/02/2005