xalib.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    xalib.h
 *  @brief   Front-end de la bibliothèque
 *  @author  Francois Fevotte <francois.fevotte@ensta.org>
 *  $Revision: 103 $
 *  $Date: 2006-04-25 17:35:44 +0200 (Tue, 25 Apr 2006) $
 */

/* $Id: xalib.h 103 2006-04-25 15:35:44Z bearclaw $ */

/* Protection contre les inclusions multiples */
#ifndef XALIB_H
#define XALIB_H
#ifdef __cplusplus
extern "C" {
#endif
#include "codes.h"

/* Gestion des mots clés 'extern' : seul le fichier xalib.c définira réellement les buffers */
#ifdef XALIB_C
#define EXTERN
#else
#define EXTERN extern
#endif


/* Variables globales */
EXTERN int XA_opendone; /* Ouverture du port effectuée ? */
EXTERN int XA_typepack; /* Type de pack courant */
EXTERN int XA_adrpack;  /* Adresse du pack courant */
EXTERN int coderr;      /* Le dernier code d'erreur renvoyé par une fonction XA */


/** Octet de poids fort d'un mot
 *  @param a mot
 *  @return octet de poids fort du mot a
 *  @remarks à tester...
 */
unsigned char hi (int a);


/** Octet de poids faible d'un mot
 *  @param x mot
 *  @return octet de poids faible du mot x
 *  @remarks à tester...
 */
unsigned char lo (int x);

/** Retour du dernier code d'erreur
 *  @return le code de retour de la derniere fonction XA appelée
 */
int XA_coderr (void);


/** Lecture d'un caractère (1 octet) dans le buffer de réception
 *  @return le caractère lu.
 *  @remarks le carcactère lu est aussi placé dans la variable globale lastget
 */
int XA_getB (void);


/** Retour du dernier caractère (octet) lu dans le buffer de réception
 *  @return le dernier caractère lu dans Rec_buffer par la fonction XA_getB
 */
long XA_lastgetB (void);


/** Lecture d'un mot (2 octets) dans le buffer de réception
 *  @return le mot lu.
 */
unsigned int XA_getW (void);


/** Lecture d'un entier long (4 octets) dans le buffer de réception
 *  @return l'entier long lu.
 */
long XA_getL (void);


/** Envoi d'une instruction vers le matériel
 *  @param send indique si l'instruction doit etre envoyée tout de suite ou bufferisée (cf. XAN() et XAN_buffer())
 *  @param fonction code de la fonction
 *  @param adrmod adresse du module auquel on parle
 *  @param arg1,arg2,arg3,arg4,arg5 arguments passés à la fonction
 *  @return le code de retour de la fonction d'envoi de message
 *
 *  @sa XAN, XAN_buffer
 */
long XA (char send, long fonction, long adrmod, long arg1, long arg2, long arg3, long arg4, long arg5);

/** Envoi immédiat d'une instruction vers le matériel
 *
 *  Le message correspondant à l'instruction est construit, puis envoyé immédiatement
 *  aux cartes. Si certains messages avaient été construits et mis en attente auparavant
 *  grâce à un appel à XAN_buffer(), ils sont envoyés en même temps.
 *
 *  @param fonction code de la fonction
 *  @param adrmod adresse du module auquel on parle
 *  @param arg1,arg2,arg3,arg4,arg5 arguments passés à la fonction
 *  @return le code de retour de la fonction d'envoi de message
 *
 *  @sa XA, XAN_buffer
 */
inline long XAN(long fonction, long adrmod, long arg1, long arg2, long arg3, long arg4, long arg5)
{
  return XA(1, fonction, adrmod, arg1, arg2, arg3, arg4, arg5);
}

/** Envoi différé d'une instruction vers le matériel
 *
 *  Le message correspondant à l'instruction est construit, mais n'est pas envoyé immédiatement
 *  aux cartes. L'appel suivant a XAN() complètera la file des messages ainsi mis en attente
 *  et les enverra tous ensemble.
 *
 *  @param fonction code de la fonction
 *  @param adrmod adresse du module auquel on parle
 *  @param arg1,arg2,arg3,arg4,arg5 arguments passés à la fonction
 *  @return le code de retour de la fonction d'envoi de message
 *
 *  @sa XA, XAN
 */
inline long XAN_buffer(long fonction, long adrmod, long arg1, long arg2, long arg3, long arg4, long arg5)
{
  return XA(0, fonction, adrmod, arg1, arg2, arg3, arg4, arg5);
}

/** Envoi d'une instruction avec arguments chaine ou long
 *  @param fonction le code de la fonction à envoyer (81 ou 202)
 *  @param adrmod l'adresse du module avec lequel on communique
 *  @param chaine argument passé à la fonction
 *  @param arg ???
 *  @return le code de retour de la fonction d'envoi du message
*/
long XAN_str (long fonction, long adrmod, char *chaine, long arg);

/** Initialisation du système XA
 *
 *  @li ouverture du port série 1
 *  @li clignotement de la led de la base
 */
void XA_startup (void);

/** Fermeture propre du système XA
 *
 *  fermeture des connexions série
 */
void XA_cleanup (void);

#undef EXTERN

#ifdef __cplusplus
}
#endif
#endif

---