os_dep_serial.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_serial.h
 *  @brief   Bibliothèque de fonctions de communication avec le port série
 *  @author  Francois Fevotte <francois.fevotte@ensta.org>
 *  $Revision: 51 $
 *  $Date: 2006-03-15 12:14:13 +0100 (Wed, 15 Mar 2006) $
 */

/* $Id: os_dep_serial.h 51 2006-03-15 11:14:13Z francois $ */

#ifndef OS_DEP_SERIAL_H
#define OS_DEP_SERIAL_H


/** @brief Fonctions de communication série
 */
namespace serial
{
  /** @brief Ouverture du port série
   *
   *  @param  serial le numéro du port série à ouvrir (1 ou 2)
   *  @return @li 0 en cas de succes
   *          @li 1 en cas d'échec
   */
  int  open( char serial );


  /** @brief Fermeture des ports série ouverts
   */
  void close(void);


  /** @brief Écriture sur le port série courant
   *
   *  Le contenu de la variable globale 'Out_buffer' est écrit sur le port série
   *  Le port série est "flushé"
   *
   *  @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 port série courant
   *
   *  Lit 'length' caractères sur le port série et les place en fin du buffer de
   *  réception 'Rec_buffer'
   *  Lit des caracteres sur le port serie jusqu'a recevoir un caractere de fin de 
   *  message (30) ou sortir en erreur de timeout.
   *  Les caracteres lus sont transcodes et places dans le buffer de reception 'Rec_buffer'.
   *  La checksum est calculee dans l'argument 'somme'
   *  
   *  @param somme la somme de tous les caracteres lus (caractere 30 final excepte)
   *  @return le nombre de caractères lus
   */
  int  read(unsigned int *somme);
}

#endif

---