source: syssvc/serial.h

/*
 *  TOPPERS/ASP Kernel
 *      Toyohashi Open Platform for Embedded Real-Time Systems/
 *      Advanced Standard Profile Kernel
 * 
 *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
 *                              Toyohashi Univ. of Technology, JAPAN
 *  Copyright (C) 2004-2011 by Embedded and Real-Time Systems Laboratory
 *              Graduate School of Information Science, Nagoya Univ., JAPAN
 * 
 *  Ÿåµ­Ãøºîž¢ŒÔ€Ï¡€°Ê²Œ€Î(1)¡Á(4)€ÎŸò·ï€òËþ€¿€¹Ÿì¹ç€ËžÂ€ê¡€ËÜ¥œ¥Õ¥È¥Š¥§
 *  ¥¢¡ÊËÜ¥œ¥Õ¥È¥Š¥§¥¢€ò²þÊÑ€·€¿€â€Î€òŽÞ€à¡¥°Ê²ŒÆ±€ž¡Ë€ò»ÈÍÑ¡ŠÊ£Àœ¡Š²þ
 *  ÊÑ¡ŠºÆÇÛÉۡʰʲŒ¡€ÍøÍрȞƀ֡ˀ¹€ë€³€È€ò̵œþ€ÇµöÂú€¹€ë¡¥
 *  (1) ËÜ¥œ¥Õ¥È¥Š¥§¥¢€ò¥œ¡Œ¥¹¥³¡Œ¥É€Î·Á€ÇÍøÍÑ€¹€ëŸì¹ç€Ë€Ï¡€Ÿåµ­€ÎÃøºî
 *      ž¢ÉœŒš¡€€³€ÎÍøÍÑŸò·ï€ª€è€Ó²Œµ­€Î̵ÊÝŸÚµ¬Äꀬ¡€€œ€Î€Þ€Þ€Î·Á€Ç¥œ¡Œ
 *      ¥¹¥³¡Œ¥ÉÃæ€ËŽÞ€Þ€ì€Æ€€€ë€³€È¡¥
 *  (2) ËÜ¥œ¥Õ¥È¥Š¥§¥¢€ò¡€¥é¥€¥Ö¥é¥ê·ÁŒ°€Ê€É¡€ÂŸ€Î¥œ¥Õ¥È¥Š¥§¥¢³«È¯€Ë»È
 *      Íрǀ­€ë·Á€ÇºÆÇÛÉÛ€¹€ëŸì¹ç€Ë€Ï¡€ºÆÇÛÉÛ€ËÈŒ€Š¥É¥­¥å¥á¥ó¥È¡ÊÍøÍÑ
 *      ŒÔ¥Þ¥Ë¥å¥¢¥ë€Ê€É¡Ë€Ë¡€Ÿåµ­€ÎÃøºîž¢ÉœŒš¡€€³€ÎÍøÍÑŸò·ï€ª€è€Ó²Œµ­
 *      €Î̵ÊÝŸÚµ¬Äê€ò·ÇºÜ€¹€ë€³€È¡¥
 *  (3) ËÜ¥œ¥Õ¥È¥Š¥§¥¢€ò¡€µ¡Žï€ËÁȀ߹þ€à€Ê€É¡€ÂŸ€Î¥œ¥Õ¥È¥Š¥§¥¢³«È¯€Ë»È
 *      Íрǀ­€Ê€€·Á€ÇºÆÇÛÉÛ€¹€ëŸì¹ç€Ë€Ï¡€Œ¡€Î€€€º€ì€«€ÎŸò·ï€òËþ€¿€¹€³
 *      €È¡¥
 *    (a) ºÆÇÛÉÛ€ËÈŒ€Š¥É¥­¥å¥á¥ó¥È¡ÊÍøÍьԥޥ˥奢¥ë€Ê€É¡Ë€Ë¡€Ÿåµ­€ÎÃø
 *        ºîž¢ÉœŒš¡€€³€ÎÍøÍÑŸò·ï€ª€è€Ó²Œµ­€Î̵ÊÝŸÚµ¬Äê€ò·ÇºÜ€¹€ë€³€È¡¥
 *    (b) ºÆÇÛÉۀηÁÂÖ€ò¡€ÊÌ€ËÄê€á€ëÊýË¡€Ë€è€Ã€Æ¡€TOPPERS¥×¥í¥ž¥§¥¯¥È€Ë
 *        Êó¹ð€¹€ë€³€È¡¥
 *  (4) ËÜ¥œ¥Õ¥È¥Š¥§¥¢€ÎÍøÍрˀè€êÄŸÀÜŪ€Þ€¿€ÏŽÖÀÜŪ€ËÀž€ž€ë€€€«€Ê€ë»
 *      ³²€«€é€â¡€Ÿåµ­Ãøºîž¢ŒÔ€ª€è€ÓTOPPERS¥×¥í¥ž¥§¥¯¥È€òÌÈÀÕ€¹€ë€³€È¡¥
 *      €Þ€¿¡€ËÜ¥œ¥Õ¥È¥Š¥§¥¢€Î¥æ¡Œ¥¶€Þ€¿€Ï¥š¥ó¥É¥æ¡Œ¥¶€«€é€Î€€€«€Ê€ëÍý
 *      ͳ€ËŽð€Å€¯ÀÁµá€«€é€â¡€Ÿåµ­Ãøºîž¢ŒÔ€ª€è€ÓTOPPERS¥×¥í¥ž¥§¥¯¥È€ò
 *      ÌÈÀÕ€¹€ë€³€È¡¥
 * 
 *  ËÜ¥œ¥Õ¥È¥Š¥§¥¢€Ï¡€ÌµÊÝŸÚ€ÇÄ󶡀µ€ì€Æ€€€ë€â€Î€Ç€¢€ë¡¥Ÿåµ­Ãøºîž¢ŒÔ€ª
 *  €è€ÓTOPPERS¥×¥í¥ž¥§¥¯¥È€Ï¡€ËÜ¥œ¥Õ¥È¥Š¥§¥¢€ËŽØ€·€Æ¡€ÆÃÄê€Î»ÈÍÑÌÜŪ
 *  €ËÂЀ¹€ëŬ¹çÀ­€âŽÞ€á€Æ¡€€€€«€Ê€ëÊÝŸÚ€â¹Ô€ï€Ê€€¡¥€Þ€¿¡€ËÜ¥œ¥Õ¥È¥Š¥§
 *  ¥¢€ÎÍøÍрˀè€êÄŸÀÜŪ€Þ€¿€ÏŽÖÀÜŪ€ËÀž€ž€¿€€€«€Ê€ë»³²€ËŽØ€·€Æ€â¡€€œ
 *  €ÎÀÕÇ€€òÉé€ï€Ê€€¡¥
 * 
 *  @(#) $Id$
 */

/*
 *              ¥·¥ê¥¢¥ë¥€¥ó¥¿¥Õ¥§¡Œ¥¹¥É¥é¥€¥Ð
 */

#ifndef TOPPERS_SERIAL_H
#define TOPPERS_SERIAL_H

#ifdef __cplusplus
extern "C" {
#endif

/*
 *  ¥·¥ê¥¢¥ë¥€¥ó¥¿¥Õ¥§¡Œ¥¹¥É¥é¥€¥Ð€ÎÍÑ€€€ë¥Ñ¥±¥Ã¥È
 */
typedef struct {
        uint_t          reacnt;                 /* Œõ¿®¥Ð¥Ã¥Õ¥¡Ãæ€ÎÊž»ú¿ô */
        uint_t          wricnt;                 /* Á÷¿®¥Ð¥Ã¥Õ¥¡Ãæ€ÎÊž»ú¿ô */
} T_SERIAL_RPOR;

/*
 *  ¥·¥ê¥¢¥ë¥€¥ó¥¿¥Õ¥§¡Œ¥¹¥É¥é¥€¥Ð€ÎœéŽü²œ¥ë¡Œ¥Á¥ó
 */
extern void             serial_initialize(intptr_t exinf) throw();

/*
 *  ¥·¥ê¥¢¥ë¥€¥ó¥¿¥Õ¥§¡Œ¥¹¥É¥é¥€¥Ð€«€é€ÎÌ€Á÷¿®Êž»ú€ÎŒèœÐ€·
 */
extern bool_t   serial_get_chr(ID portid, char *p_c) throw();

/*
 *  ¥·¥ê¥¢¥ë¥€¥ó¥¿¥Õ¥§¡Œ¥¹¥É¥é¥€¥Ð€Î¥µ¡Œ¥Ó¥¹¥³¡Œ¥ë
 */
extern ER               serial_opn_por(ID portid) throw();
extern ER               serial_cls_por(ID portid) throw();
extern ER_UINT  serial_rea_dat(ID portid, char *buf, uint_t len) throw();
extern ER_UINT  serial_wri_dat(ID portid, const char *buf, uint_t len) throw();
extern ER               serial_ctl_por(ID portid, uint_t ioctl) throw();
extern ER               serial_ref_por(ID portid, T_SERIAL_RPOR *pk_rpor) throw();

/*
 *  ¥·¥ê¥¢¥ë¥€¥ó¥¿¥Õ¥§¡Œ¥¹¥É¥é¥€¥Ð€ÎÆ°ºîÀ©žæÍр΀¿€á€ÎÄê¿ô
 *
 *  °Ê²Œ€ÎÄê¿ô€Ï¡€¥Ó¥Ã¥ÈËè€ËÏÀÍýÏ€ò€È€Ã€ÆÍÑ€€€ë¡¥
 */
#define IOCTL_NULL      0U                      /* »ØÄê€Ê€· */
#define IOCTL_ECHO      0x0001U         /* Œõ¿®€·€¿Êž»ú€ò¥š¥³¡Œ¥Ð¥Ã¥¯ */
#define IOCTL_CRLF      0x0010U         /* LF€òÁ÷¿®€¹€ëÁ°€ËCR€òÉղà */
#define IOCTL_FCSND     0x0100U         /* Á÷¿®€ËÂЀ·€Æ¥Õ¥í¡ŒÀ©žæ€ò¹Ô€Š */
#define IOCTL_FCANY     0x0200U         /* €É€Î€è€Š€ÊÊž»ú€Ç€âÁ÷¿®ºÆ³« */
#define IOCTL_FCRCV     0x0400U         /* Œõ¿®€ËÂЀ·€Æ¥Õ¥í¡ŒÀ©žæ€ò¹Ô€Š */

#ifdef __cplusplus
}
#endif

#endif /* TOPPERS_SERIAL_H */