cmdproc/include/cmdproc_io_tisci.h

   1 /** @file cmdio_tisci.h
   2 *   @brief Texas Instrument SCI IO for cmdProc header file
   3 *   @date 1.August.2012
   4 *
   5 *  Definition of IO for TMS570LS3137ZWT
   6 */
   7
   8
   9 #ifndef CMDIO_BUFFER_H_
  10 #define CMDIO_BUFFER_H_
  11
  12 /* Include files */
  13 #include "cmdproc.h"
  14
  15 /**     Puts character into output buffer. Is blocking, when buffer is full.
  16  *      @param[in]      cmd_io  IO stack pointer
  17  *      @param[in]      ch      Character to be printed
  18  *      @return 1 when succes, 0 when fail
  19  */
  20 int tisci_putc(cmd_io_t *cmd_io, int ch);
  21
  22 /**     Gets character from input buffer, is blocking when buffer is empty.
  23  *      @param[in]      cmd_io  IO stack pointer
  24  *      @return read character
  25  */
  26 int tisci_getc(cmd_io_t *cmd_io);
  27
  28 /**     Writes string into output buffer, is blocking when buffer is full.
  29  *      @param[in]      cmd_io  IO stack pointer
  30  *      @param[in]      buf     String to be written
  31  *      @param[in]      count   Number of character to be written
  32  *      @return number of written characters
  33  */
  34 int tisci_write(cmd_io_t *cmd_io, const void *buf, int count);
  35
  36 /**     Reads string from input buffer, is blocking when buffer is empty.
  37  *      @param[in]      cmd_io  IO stack pointer
  38  *      @param[out]     buf     Buffer into which string be read
  39  *      @param[in]      count   Number of character to be read
  40  *      @return number of read characters
  41  */
  42 int tisci_read(cmd_io_t *cmd_io, void *buf, int count);
  43
  44 #endif /* CMDIO_BUFFER_H_ */
  45