FITkit
Fakulta informačních technologií

Dokumentace souboru enc28j60_spi_rx.h

Knihovna funkcí pro práci s přijímacím bufferem v ENC28J60. ...

Zobrazit zdrojový text tohoto souboru.

Definice maker

#define NULL   0
 NULL pointer.
#define rx_skip(len)   rx_read(NULL, len)
 přeskočí len bajtů v bufferu.

Funkce

unsigned int rx_getc ()
 Přečte bajt z bufferu.
unsigned int rx_read (void *ptr, int length)
 Přečte blok dat velikosti length z bufferu a zapíše na adresu odkazovanou ukazatelem ptr.
unsigned int rx_getline (void *ptr, int max_length)
 Přečte řetězec ukončený hodnotou LF z bufferu a zapíše na adresu odkazovanou ukazatelem ptr.
int rx_left ()
 Vrátí počet zbývajících bajtů v bufferu.
unsigned char rx_isempty ()
 Kontroluje zda je buffer přečten celý.


Detailní popis

Knihovna funkcí pro práci s přijímacím bufferem v ENC28J60.

Definice v souboru enc28j60_spi_rx.h.


Dokumentace k definicím maker

#define NULL   0

#define rx_skip ( len   )     rx_read(NULL, len)

přeskočí len bajtů v bufferu.

Parametry:
len - počet přeskočených bajtů

Definice je uvedena na řádku 145 v souboru enc28j60_spi_rx.h.

Používá se v ip_recv(), tcp_recv() a UDP_APP_HANDLER().


Dokumentace funkcí

unsigned int rx_getc (  )  [inline]

Přečte bajt z bufferu.

Návratová hodnota:
hodnota bajtu , -1 při konci paketu

Definice je uvedena na řádku 116 v souboru enc28j60_spi_rx.c.

Odkazuje se na rx_pkt_len a spi_getc().

Používá se v UDP_APP_HANDLER().

unsigned int rx_getline ( void *  ptr,
int  max_length 
)

Přečte řetězec ukončený hodnotou LF z bufferu a zapíše na adresu odkazovanou ukazatelem ptr.

Parametry:
ptr - ukazatel na řetězec, 0 pro přes
max_length - maximální délka řetězce
Návratová hodnota:
počet přečtených bajtů

Definice je uvedena na řádku 147 v souboru enc28j60_spi_rx.c.

Odkazuje se na rx_pkt_len a spi_getline().

unsigned char rx_isempty (  )  [inline]

Kontroluje zda je buffer přečten celý.

Vracené hodnoty:
0 - v bufferu zbývají nepřečtená data
1 - buffer je přečten celý

Definice je uvedena na řádku 180 v souboru enc28j60_spi_rx.c.

Odkazuje se na rx_pkt_len.

int rx_left (  )  [inline]

Vrátí počet zbývajících bajtů v bufferu.

Návratová hodnota:
počet zbývajících bajtů

Definice je uvedena na řádku 172 v souboru enc28j60_spi_rx.c.

Odkazuje se na rx_pkt_len.

Používá se v icmp_recv(), tcp_fsm() a UDP_APP_HANDLER().

unsigned int rx_read ( void *  ptr,
int  length 
)

Přečte blok dat velikosti length z bufferu a zapíše na adresu odkazovanou ukazatelem ptr.

Parametry:
ptr - ukazatel, kam se bude zapisovat
length - délka dat v bajtech
Návratová hodnota:
počet přečtených bajtů

Definice je uvedena na řádku 127 v souboru enc28j60_spi_rx.c.

Odkazuje se na rx_pkt_len a spi_read().

Používá se v arp_recv(), eth_recv(), icmp_recv(), ip_recv(), tcp_recv(), UDP_APP_HANDLER() a udp_recv().