opencbm-plugin.h

Go to the documentation of this file.

/*
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version
 *  2 of the License, or (at your option) any later version.
 *
 *  Copyright 2008-2009, 2011 Spiro Trikaliotis
 *  Copyright 2011      Wolfgang Moser
 */

#ifndef OPENCBM_PLUGIN_H
#define OPENCBM_PLUGIN_H

#include "opencbm.h"

typedef int CBMAPIDECL opencbm_plugin_init_t(void); 

typedef void CBMAPIDECL opencbm_plugin_uninit_t(void); 

typedef const char * CBMAPIDECL opencbm_plugin_get_driver_name_t(const char * const Port);

typedef int CBMAPIDECL opencbm_plugin_driver_open_t(CBM_FILE *HandleDevice, const char * const Port);

typedef void CBMAPIDECL opencbm_plugin_driver_close_t(CBM_FILE HandleDevice);

typedef void CBMAPIDECL opencbm_plugin_lock_t(CBM_FILE HandleDevice);

typedef void CBMAPIDECL opencbm_plugin_unlock_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_raw_write_t(CBM_FILE HandleDevice, const void *Buffer, size_t Count);

typedef int CBMAPIDECL opencbm_plugin_raw_read_t(CBM_FILE HandleDevice, void *Buffer, size_t Count);

typedef int CBMAPIDECL opencbm_plugin_open_t(CBM_FILE HandleDevice, unsigned char DeviceAddress, unsigned char SecondaryAddress);

typedef int CBMAPIDECL opencbm_plugin_close_t(CBM_FILE HandleDevice, unsigned char DeviceAddress, unsigned char SecondaryAddress);

typedef int CBMAPIDECL opencbm_plugin_listen_t(CBM_FILE HandleDevice, unsigned char DeviceAddress, unsigned char SecondaryAddress);

typedef int CBMAPIDECL opencbm_plugin_talk_t(CBM_FILE HandleDevice, unsigned char DeviceAddress, unsigned char SecondaryAddress);

typedef int CBMAPIDECL opencbm_plugin_unlisten_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_untalk_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_get_eoi_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_clear_eoi_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_reset_t(CBM_FILE HandleDevice);

typedef unsigned char CBMAPIDECL opencbm_plugin_pp_read_t(CBM_FILE HandleDevice);

typedef void CBMAPIDECL opencbm_plugin_pp_write_t(CBM_FILE HandleDevice, unsigned char Byte);

typedef int CBMAPIDECL opencbm_plugin_iec_poll_t(CBM_FILE HandleDevice);

typedef void CBMAPIDECL opencbm_plugin_iec_set_t(CBM_FILE HandleDevice, int Line);

typedef void CBMAPIDECL opencbm_plugin_iec_release_t(CBM_FILE HandleDevice, int Line);

typedef void CBMAPIDECL opencbm_plugin_iec_setrelease_t(CBM_FILE HandleDevice, int Set, int Release);

typedef int CBMAPIDECL opencbm_plugin_iec_wait_t(CBM_FILE HandleDevice, int Line, int State);

typedef unsigned char CBMAPIDECL opencbm_plugin_parallel_burst_read_t(CBM_FILE HandleDevice);

typedef void CBMAPIDECL opencbm_plugin_parallel_burst_write_t(CBM_FILE HandleDevice, unsigned char Value);

typedef int CBMAPIDECL opencbm_plugin_parallel_burst_read_n_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length);

typedef int CBMAPIDECL opencbm_plugin_parallel_burst_write_n_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length);

typedef int CBMAPIDECL opencbm_plugin_parallel_burst_read_track_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length);

typedef int CBMAPIDECL opencbm_plugin_parallel_burst_read_track_var_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length);

typedef int CBMAPIDECL opencbm_plugin_parallel_burst_write_track_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length);

typedef int CBMAPIDECL opencbm_plugin_tap_prepare_capture_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_prepare_write_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_get_sense_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_wait_for_stop_sense_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_wait_for_play_sense_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_motor_on_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_motor_off_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_start_capture_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Buffer_Length, int *Status, int *BytesRead);
typedef int CBMAPIDECL opencbm_plugin_tap_start_write_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length, int *Status, int *BytesWritten);
typedef int CBMAPIDECL opencbm_plugin_tap_get_ver_t(CBM_FILE HandleDevice, int *Status);
typedef int CBMAPIDECL opencbm_plugin_tap_download_config_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Buffer_Length, int *Status, int *BytesRead);
typedef int CBMAPIDECL opencbm_plugin_tap_upload_config_t(CBM_FILE HandleDevice, unsigned char *Buffer, unsigned int Length, int *Status, int *BytesWritten);
typedef int CBMAPIDECL opencbm_plugin_tap_break_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_s1_read_n_t (CBM_FILE HandleDevice,       unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_s1_write_n_t(CBM_FILE HandleDevice, const unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_s2_read_n_t (CBM_FILE HandleDevice,       unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_s2_write_n_t(CBM_FILE HandleDevice, const unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_s3_read_n_t (CBM_FILE HandleDevice,       unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_s3_write_n_t(CBM_FILE HandleDevice, const unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_pp_dc_read_n_t (CBM_FILE HandleDevice,       unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_pp_dc_write_n_t(CBM_FILE HandleDevice, const unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_pp_cc_read_n_t (CBM_FILE HandleDevice,       unsigned char *data, unsigned int size);

typedef int CBMAPIDECL opencbm_plugin_pp_cc_write_n_t(CBM_FILE HandleDevice, const unsigned char *data, unsigned int size);


typedef int CBMAPIDECL opencbm_plugin_iec_dbg_read_t(CBM_FILE HandleDevice);

typedef int CBMAPIDECL opencbm_plugin_iec_dbg_write_t(CBM_FILE HandleDevice, unsigned char Value);


typedef
struct opencbm_plugin_s {
    opencbm_plugin_init_t                       * opencbm_plugin_init;                       
    opencbm_plugin_uninit_t                     * opencbm_plugin_uninit;                     
    opencbm_plugin_get_driver_name_t            * opencbm_plugin_get_driver_name;            
    opencbm_plugin_driver_open_t                * opencbm_plugin_driver_open;                
    opencbm_plugin_driver_close_t               * opencbm_plugin_driver_close;               
    opencbm_plugin_lock_t                       * opencbm_plugin_lock;                       
    opencbm_plugin_unlock_t                     * opencbm_plugin_unlock;                     
    opencbm_plugin_raw_write_t                  * opencbm_plugin_raw_write;                  
    opencbm_plugin_raw_read_t                   * opencbm_plugin_raw_read;                   
    opencbm_plugin_open_t                       * opencbm_plugin_open;                       
    opencbm_plugin_close_t                      * opencbm_plugin_close;                      
    opencbm_plugin_listen_t                     * opencbm_plugin_listen;                     
    opencbm_plugin_talk_t                       * opencbm_plugin_talk;                       
    opencbm_plugin_unlisten_t                   * opencbm_plugin_unlisten;                   
    opencbm_plugin_untalk_t                     * opencbm_plugin_untalk;                     
    opencbm_plugin_get_eoi_t                    * opencbm_plugin_get_eoi;                    
    opencbm_plugin_clear_eoi_t                  * opencbm_plugin_clear_eoi;                  
    opencbm_plugin_reset_t                      * opencbm_plugin_reset;                      
    opencbm_plugin_pp_read_t                    * opencbm_plugin_pp_read;                    
    opencbm_plugin_pp_write_t                   * opencbm_plugin_pp_write;                   
    opencbm_plugin_iec_poll_t                   * opencbm_plugin_iec_poll;                   
    opencbm_plugin_iec_set_t                    * opencbm_plugin_iec_set;                    
    opencbm_plugin_iec_release_t                * opencbm_plugin_iec_release;                
    opencbm_plugin_iec_setrelease_t             * opencbm_plugin_iec_setrelease;             
    opencbm_plugin_iec_wait_t                   * opencbm_plugin_iec_wait;                   
    opencbm_plugin_parallel_burst_read_t        * opencbm_plugin_parallel_burst_read;        
    opencbm_plugin_parallel_burst_write_t       * opencbm_plugin_parallel_burst_write;       
    opencbm_plugin_parallel_burst_read_n_t      * opencbm_plugin_parallel_burst_read_n;      
    opencbm_plugin_parallel_burst_write_n_t     * opencbm_plugin_parallel_burst_write_n;     
    opencbm_plugin_parallel_burst_read_track_t  * opencbm_plugin_parallel_burst_read_track;  
    opencbm_plugin_parallel_burst_write_track_t * opencbm_plugin_parallel_burst_write_track; 
    opencbm_plugin_parallel_burst_read_track_var_t * opencbm_plugin_parallel_burst_read_track_var;  
    opencbm_plugin_iec_dbg_read_t               * opencbm_plugin_iec_dbg_read;               
    opencbm_plugin_iec_dbg_write_t              * opencbm_plugin_iec_dbg_write;              
    opencbm_plugin_parallel_burst_read_t        * opencbm_plugin_srq_burst_read;        
    opencbm_plugin_parallel_burst_write_t       * opencbm_plugin_srq_burst_write;       
    opencbm_plugin_parallel_burst_read_n_t      * opencbm_plugin_srq_burst_read_n;      
    opencbm_plugin_parallel_burst_write_n_t     * opencbm_plugin_srq_burst_write_n;     
    opencbm_plugin_parallel_burst_read_track_t  * opencbm_plugin_srq_burst_read_track;  
    opencbm_plugin_parallel_burst_write_track_t * opencbm_plugin_srq_burst_write_track; 
    opencbm_plugin_tap_prepare_capture_t        * opencbm_plugin_tap_prepare_capture;     
    opencbm_plugin_tap_prepare_write_t          * opencbm_plugin_tap_prepare_write;       
    opencbm_plugin_tap_get_sense_t              * opencbm_plugin_tap_get_sense;           
    opencbm_plugin_tap_wait_for_stop_sense_t    * opencbm_plugin_tap_wait_for_stop_sense; 
    opencbm_plugin_tap_wait_for_play_sense_t    * opencbm_plugin_tap_wait_for_play_sense; 
    opencbm_plugin_tap_motor_on_t               * opencbm_plugin_tap_motor_on;            
    opencbm_plugin_tap_motor_off_t              * opencbm_plugin_tap_motor_off;           
    opencbm_plugin_tap_start_capture_t          * opencbm_plugin_tap_start_capture;       
    opencbm_plugin_tap_start_write_t            * opencbm_plugin_tap_start_write;         
    opencbm_plugin_tap_get_ver_t                * opencbm_plugin_tap_get_ver;             
    opencbm_plugin_tap_download_config_t        * opencbm_plugin_tap_download_config;     
    opencbm_plugin_tap_upload_config_t          * opencbm_plugin_tap_upload_config;       
    opencbm_plugin_tap_break_t                  * opencbm_plugin_tap_break;               
} opencbm_plugin_t;

#endif // #ifndef OPENCBM_PLUGIN_H