sanei_usb.h

Go to the documentation of this file.

/* sane - Scanner Access Now Easy.
   Copyright (C) 2001, 2002 Henning Meier-Geinitz
   Copyright (C) 2003, 2005 Rene Rebe (sanei_read_int,sanei_set_timeout)
   Copyright (C) 2008 m. allan noah (sanei_usb_clear_halt)
   Copyright (C) 2011 Reinhold Kainhofer (sanei_usb_set_endpoint)
   This file is part of the SANE package.
 
   SANE 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.
 
   SANE is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
   License for more details.
 
   You should have received a copy of the GNU General Public License
   along with sane; see the file COPYING.
   If not, see <https://www.gnu.org/licenses/>.
 
   As a special exception, the authors of SANE give permission for
   additional uses of the libraries contained in this release of SANE.
 
   The exception is that, if you link a SANE library with other files
   to produce an executable, this does not by itself cause the
   resulting executable to be covered by the GNU General Public
   License.  Your use of that executable is in no way restricted on
   account of linking the SANE library code into it.
 
   This exception does not, however, invalidate any other reasons why
   the executable file might be covered by the GNU General Public
   License.
 
   If you submit changes to SANE to the maintainers to be included in
   a subsequent release, you agree by submitting the changes that
   those changes may be distributed with this exception intact.
 
   If you write modifications of your own for SANE, it is your choice
   whether to permit this exception to apply to your modifications.
   If you do not wish that, delete this exception notice.
*/
 
#ifndef sanei_usb_h
#define sanei_usb_h
 
#include "../include/sane/config.h"
#include "../include/sane/sane.h"
 
#include <stdlib.h> /* for size_t */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* USB spec defines */
#ifndef USB_CLASS_PER_INTERFACE
/* Also defined in libusb */
/* @{ */
#define USB_CLASS_PER_INTERFACE         0x00
#define USB_CLASS_AUDIO                 0x01
#define USB_CLASS_COMM                  0x02
#define USB_CLASS_HID                   0x03
#define USB_CLASS_PRINTER               0x07
#define USB_CLASS_MASS_STORAGE          0x08
#define USB_CLASS_HUB                   0x09
#define USB_CLASS_DATA                  0x0a
#define USB_CLASS_VENDOR_SPEC           0xff
/* @} */
 
/* @{ */
#define USB_DT_DEVICE                   0x01
#define USB_DT_CONFIG                   0x02
#define USB_DT_STRING                   0x03
#define USB_DT_INTERFACE                0x04
#define USB_DT_ENDPOINT                 0x05
#define USB_DT_HID                      0x21
#define USB_DT_REPORT                   0x22
#define USB_DT_PHYSICAL                 0x23
#define USB_DT_HUB                      0x29
/* @} */
 
/* @{ */
#define USB_DT_DEVICE_SIZE              18
#define USB_DT_CONFIG_SIZE              9
#define USB_DT_INTERFACE_SIZE           9
#define USB_DT_ENDPOINT_SIZE            7
#define USB_DT_ENDPOINT_AUDIO_SIZE      9
#define USB_DT_HUB_NONVAR_SIZE          7
/* @} */
 
/* @{ */
#define USB_ENDPOINT_ADDRESS_MASK       0x0f
#define USB_ENDPOINT_DIR_MASK           0x80
#define USB_ENDPOINT_TYPE_MASK          0x03
#define USB_ENDPOINT_TYPE_CONTROL       0
#define USB_ENDPOINT_TYPE_ISOCHRONOUS   1
#define USB_ENDPOINT_TYPE_BULK          2
#define USB_ENDPOINT_TYPE_INTERRUPT     3
/* @} */
 
/* @{ */
#define USB_REQ_GET_STATUS              0x00
#define USB_REQ_CLEAR_FEATURE           0x01
#define USB_REQ_SET_FEATURE             0x03
#define USB_REQ_SET_ADDRESS             0x05
#define USB_REQ_GET_DESCRIPTOR          0x06
#define USB_REQ_SET_DESCRIPTOR          0x07
#define USB_REQ_GET_CONFIGURATION       0x08
#define USB_REQ_SET_CONFIGURATION       0x09
#define USB_REQ_GET_INTERFACE           0x0A
#define USB_REQ_SET_INTERFACE           0x0B
#define USB_REQ_SYNCH_FRAME             0x0C
/* @} */
 
/* @{ */
#define USB_TYPE_STANDARD               (0x00 << 5)
#define USB_TYPE_CLASS                  (0x01 << 5)
#define USB_TYPE_VENDOR                 (0x02 << 5)
#define USB_TYPE_RESERVED               (0x03 << 5)
/* @} */
 
/* @{ */
#define USB_RECIP_DEVICE                0x00
#define USB_RECIP_INTERFACE             0x01
#define USB_RECIP_ENDPOINT              0x02
#define USB_RECIP_OTHER                 0x03
/* @} */
 
#endif /* not USB_CLASS_PER_INTERFACE */
 
/* Not defined in libsub */
/* @{ */
#define USB_TYPE_MASK                   (0x03 << 5)
#define USB_RECIP_MASK                  0x1f
/* @} */
 
/* @{ */
#define USB_DIR_OUT                     0x00
#define USB_DIR_IN                      0x80
/* @} */
 
struct sanei_usb_dev_descriptor
{
        SANE_Byte    desc_type;
        unsigned int bcd_usb;
        unsigned int bcd_dev;
        SANE_Byte    dev_class;
        SANE_Byte    dev_sub_class;
        SANE_Byte    dev_protocol;
        SANE_Byte    max_packet_size;
};
 
extern SANE_Status sanei_usb_testing_enable_replay(SANE_String_Const path,
                                                   int development_mode);
 
extern SANE_Status sanei_usb_testing_enable_record(SANE_String_Const path,
                                                   SANE_String_Const be_name);
 
extern SANE_String sanei_usb_testing_get_backend(void);
 
extern SANE_Bool sanei_usb_is_replay_mode_enabled(void);
 
extern void sanei_usb_testing_record_clear(void);
 
extern void sanei_usb_testing_record_message(SANE_String_Const message);
 
extern void sanei_usb_init (void);
 
extern void sanei_usb_exit (void);
 
extern void sanei_usb_scan_devices (void);
 
SANE_Status
sanei_usb_get_vendor_product_byname (SANE_String_Const devname,
                                     SANE_Word * vendor, SANE_Word * product);
 
extern SANE_Status
sanei_usb_get_vendor_product (SANE_Int dn, SANE_Word * vendor,
                              SANE_Word * product);
 
extern SANE_Status
sanei_usb_find_devices (SANE_Int vendor, SANE_Int product,
                        SANE_Status (*attach) (SANE_String_Const devname));
 
extern SANE_Status sanei_usb_open (SANE_String_Const devname, SANE_Int * dn);
 
extern void sanei_usb_set_endpoint (SANE_Int dn, SANE_Int ep_type, SANE_Int ep);
 
extern SANE_Int sanei_usb_get_endpoint (SANE_Int dn, SANE_Int ep_type);
 
extern void sanei_usb_close (SANE_Int dn);
 
extern void sanei_usb_set_timeout (SANE_Int timeout);
 
#define HAVE_SANEI_USB_SET_TIMEOUT
 
extern SANE_Status sanei_usb_clear_halt (SANE_Int dn);
 
#define HAVE_SANEI_USB_CLEAR_HALT
 
extern SANE_Status sanei_usb_reset (SANE_Int dn);
 
extern SANE_Status
sanei_usb_read_bulk (SANE_Int dn, SANE_Byte * buffer, size_t * size);
 
extern SANE_Status
sanei_usb_write_bulk (SANE_Int dn, const SANE_Byte * buffer, size_t * size);
 
extern SANE_Status
sanei_usb_control_msg (SANE_Int dn, SANE_Int rtype, SANE_Int req,
                       SANE_Int value, SANE_Int index, SANE_Int len,
                       SANE_Byte * data);
 
extern SANE_Status
sanei_usb_read_int (SANE_Int dn, SANE_Byte * buffer, size_t * size);
 
extern void
sanei_usb_attach_matching_devices (const char *name,
                                   SANE_Status (*attach) (const char *dev));
 
extern SANE_Status
sanei_usb_set_configuration (SANE_Int dn, SANE_Int configuration);
 
extern SANE_Status
sanei_usb_claim_interface (SANE_Int dn, SANE_Int interface_number);
 
extern SANE_Status
sanei_usb_release_interface (SANE_Int dn, SANE_Int interface_number);
 
extern SANE_Status
sanei_usb_set_altinterface (SANE_Int dn, SANE_Int alternate);
 
extern SANE_Status
sanei_usb_get_descriptor( SANE_Int dn, struct sanei_usb_dev_descriptor *desc );
 
#ifdef __cplusplus
} // extern "C"
#endif
 
/*------------------------------------------------------*/
#endif /* sanei_usb_h */