tkdn_sci.h

説明を見る。

/*******************************************************************************
* RXduinoライブラリ & 特電HAL
* 
* このソフトウェアは特殊電子回路株式会社によって開発されたものです。
* 当社Webサイトを通じてダウンロードすることによって使用許諾されます。
* このファイルを第三者へ開示・再配布・貸与・譲渡することはできません。
* このソフトウェアはあるがままの状態で提供され、内容および動作についての保障はあ
* りません。弊社はファイルの内容および実行結果についていかなる責任も負いません。
* お客様は、お客様の製品開発のために当ソフトウェアのソースコードを自由に参照し、
* 引用していただくことができます。
* コンパイル・リンク後のオブジェクトファイル(ELF ファイルまたはMOT,SRECファイル)
* であって、デバッグ情報が削除されている場合は第三者に再配布することができます。
* (C) Copyright 2011-2014 TokushuDenshiKairo Inc. 特殊電子回路株式会社
* http://rx.tokudenkairo.co.jp/
*******************************************************************************/

#ifndef __H_TKDN_SCI
#define __H_TKDN_SCI
/**************************************************************************/
#include "tkdn_hal.h"

#ifdef __cplusplus
extern "C" {
#endif

#define SCI_TXINTERRUPT_NOTUSE  0
#define SCI_TXINTERRUPT_USE     1

/*********************************************************************/
typedef enum {
    SCI_NONE,     
    SCI_AUTO,     
    SCI_USB0,     
    SCI_USB1,     
    SCI_SCI0P2x,  
    SCI_SCI1JTAG, 
    SCI_SCI2A,    
    SCI_SCI2B,    
    SCI_SCI6A,    
    SCI_SCI6B,    
} SCI_PORT;

/*********************************************************************/
typedef enum {
    CRLF_NONE, 
    CRLF_CR,   
    CRLF_CRLF, 
} CRLFMODE;


//■■■■■■■■■■■■■■■■■■■■■■■■■
//  ユーザがカスタマイズする場所

#define SCI_BUFSIZE  256          // 受信・送信があるので実際にはこの2倍のメモリを使う
                                  // 2^nの値を指定すること

// SCI TX割り込みを使うならここを書き換える
#define SCI_TXINTERRUPT_MODE    SCI_TXINTERRUPT_USE

//  カスタマイズはここまで
//■■■■■■■■■■■■■■■■■■■■■■■■■

typedef struct sci_str
{
    // 送受信バッファ
    volatile char rxbuf[SCI_BUFSIZE];
    volatile char txbuf[SCI_BUFSIZE];
    
    // 送受信バッファのポインタ
    volatile int     tx_rptr;
    volatile int     tx_wptr;
    volatile int     rx_rptr;
    volatile int     rx_wptr;
    
    volatile SCI_PORT port;
    volatile CRLFMODE crlf_tx;
    volatile CRLFMODE crlf_rx;
} sci_str;

typedef struct sci_str sci_t; 

//各種関数

/*********************************************************************/
SCI_PORT sci_init(SCI_PORT _port,int bps);

/*********************************************************************/
SCI_PORT sci_getport(void);

/*********************************************************************/
int sci_putc(char c);

/*********************************************************************/
int sci_puts(const char *str);

/*********************************************************************/
char sci_getc(void);

/*********************************************************************/
char *sci_gets(char *s,int max);

/*********************************************************************/
void sci_writedata(const unsigned char *data,int len);

/*********************************************************************/
void sci_readdata(unsigned char *data,int len);

/*********************************************************************/
int  sci_rxcount(void);

/*********************************************************************/
void sci_convert_crlf(CRLFMODE tx,CRLFMODE rx);

/*********************************************************************/
char sci_peek(void);

/*********************************************************************/
void sci_flush(void);


// 拡張版SCIルーチン

// SCIの初期化
TKDN_HAL
void sci_init_ex(sci_t *sci,SCI_PORT _port,int bps);

// SCIの使用ポートを取得
TKDN_HAL
SCI_PORT sci_getport_ex(sci_t *sci);

// １文字送信
//   ※失敗(送信バッファFULL)したら0を返す
TKDN_HAL
int sci_putc_ex(sci_t *sci,char c);

// 文字列送信
//   ※失敗(送信バッファFULL)したら0を返す
TKDN_HAL
int sci_puts_ex(sci_t *sci,const char *str);

// １文字受信
//  ※受信した文字がなければ\0を返す
TKDN_HAL
char sci_getc_ex(sci_t *sci);

// 文字列受信
// 最大max文字受信する
// 最後にヌルターミネータをつけるが、最大文字数に達した場合はヌルターミネータはつけない
TKDN_HAL
char *sci_gets_ex(sci_t *sci,char *s,int max);

// バイナリデータ送信
TKDN_HAL
void sci_writedata_ex(sci_t *sci,const unsigned char *data,int len);

// バイナリデータ受信
//  ※指定されたデータ量を受信するまで制御を返さない
TKDN_HAL
void sci_readdata_ex(sci_t *sci,unsigned char *data,int len);

// 受信バッファに溜まっているデータ数を調べる
TKDN_HAL
int  sci_rxcount_ex(sci_t *sci);

// CRやLFの変換をSCIライブラリ内で行う
TKDN_HAL
void sci_convert_crlf_ex(sci_t *sci,CRLFMODE tx,CRLFMODE rx);

// データを覗き見る
TKDN_HAL
char sci_peek_ex(sci_t *sci);

// 送信データをフラッシュする
TKDN_HAL
void sci_flush_ex(sci_t *sci);

// 
TKDN_HAL
void sci_regist_default(sci_t *sci);

#ifdef __cplusplus
}
#endif

#endif // __H_TKDN_SCI