os_dep_usb.h

Go to the documentation of this file.

/*  Implémentation Linux de la bibliotheque XADLL de Sidena
 *  Copyright (C) 2005 ENSTAR
 *
 *  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.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  You can contact us:
 *    Association ENSTAR
 *    Ecole Nationale Superieure de Techniques Avancees
 *    32 boulevard Victor
 *    75739 Paris Cedex 15
 *    FRANCE
 *
 *    enstar@ensta.fr
 */

/** @file    os_dep_usb.h
 *  @brief   Bibliothèque de fonctions de communication avec le port USB
 *  @author  Francois Fevotte <francois.fevotte@ensta.org>
 *  $Revision: 7 $
 *  $Date: 2006-02-13 14:34:33 +0100 (Mon, 13 Feb 2006) $
 */

/* $Id: os_dep_usb.h 7 2006-02-13 13:34:33Z francois $ */

#ifndef OS_DEP_USB_H
#define OS_DEP_USB_H


/** @brief Fonctions de communication USB
 */
namespace usb
{
  /** @brief Ouverture du périphérique USB
   *    
   *  Le périphérique USB est détecté, ouvert puis configuré selon la séquence suivante :
   *     @li listage des périphériques FTDI
   *     @li ouverture du premier périphérique FTDI
   *     @li réinitialisation
   *     @li réglage des 'timeouts' d'écriture et lecture à 100ms
   *
   *  @return @li 0 en cas de succes
   *          @li 1 en cas d'échec
   */
  int  open(void);


  /** @brief Fermeture du périphérique USB
   */
  void close(void);


  /** @brief Écriture sur le périphérique USB
   *
   *  Le contenu de la variable globale 'Out_buffer' est envoyé au périphérique USB
   *
   *  @param length longueur du buffer à transmettre
   *  @return @li 1 en cas de succès
   *          @li 0 en cas d'échec
   */
  int  write(short length);


  /** @brief Lecture sur le périphérique USB
   *
   *  Lit 'length' caractères sur le périphérique USB et les place en fin du buffer de réception 'Rec_buffer'
   *  
   *  @param length le nombre de caractères à lire
   *  @return le nombre de caractères lus
   */
  int  read(short length);
}

#endif

---