utils/extest/extest.h

   1 /**
   2  * @file extest.h
   3  *
   4  * @brief Extensible Test program's public API
   5  *
   6  * This header declares the API for the user that intends to add more
   7  * commands on top of the built-in ones.
   8  *
   9  * @author Copyright (C) 2009 CERN CO/HT Emilio G. Cota
  10  *                                      <emilio.garcia.cota@cern.ch>
  11  * @author Copyright (C) 2008 CERN CO/HT Yury Georgievskiy
  12  *                                      <yury.georgievskiy@cern.ch>
  13  *
  14  * @section license_sec License
  15  * Released under the GPL v2. (and only v2, not any later version)
  16  */
  17 #ifndef _EXTEST_H_
  18 #define _EXTEST_H_
  19
  20 #include <extest_common.h>
  21
  22 /*! @name extest's public API
  23  */
  24 //@{
  25 //!< Device Node open File Descriptor
  26 #define _DNFD (tst_glob_d.fd)
  27
  28 //!< User wants verbose command help
  29 #define VERBOSE_HELP (-1)
  30
  31 //! Test program Error return codes
  32 typedef enum _tag_tst_prog_error {
  33         TST_NO_ERR,             //!< cool
  34         TST_ERR_NOT_IMPL,       //!< function not implemented
  35         TST_ERR_NO_PARAM,       //!< compulsory parameter is not provided
  36         TST_ERR_WRONG_ARG,      //!< wrong command argument
  37         TST_ERR_ARG_O_S,        //!< argument overflow/shortcoming
  38         TST_ERR_NO_MODULE,      //!< active module not set
  39         TST_ERR_IOCTL,          //!< ioctl call fails
  40         TST_ERR_SYSCALL,        //!< system call fails
  41         TST_ERR_NO_VECTOR,      //!< vector for this call is not provided
  42         TST_ERR_LAST            //!< error idx
  43 } tst_prg_err_t;
  44
  45 int     do_yes_no       (char *question, char *extra);
  46 int     compulsory_ok   (struct cmd_desc *cmdd);
  47 int     extest_init     (int argc, char **argv);
  48 int     is_last_atom    (struct atom *atom);
  49 //@}
  50
  51 #endif /* _EXTEST_H_ */