networkif.h

#ifndef NETWORKIF_H
#define NETWORKIF_H 1
 
#include "main-header.h"
#include "stdint.h"
 
// various bits defining the status
// was it probed?
#define STATUS_PROBED 0
// did probe succeed?
#define STATUS_PROBE_SUCCESS 1
// was it successfully initialised
#define STATUS_INITIALISED 2
// is it ready to transmit? (the device sets and clears this)
#define STATUS_READY_TO_TRANSMIT 3
 
// a registered network device
typedef struct network_context {
  struct networkif *    nif;
  uint8_t               status;
  uint8_t               source;
  MCULIB_HANDLE         mculib_handle;
} _network_context_t;
 
// an instance of a network device
typedef struct networkif {
  int (*probe)(struct network_context *nc);                                             // return 0 if device exists
  int (*init)(struct network_context *nc);                                              // return 0 if device was initialised
  int (*loop)(struct network_context *nc);                                              // return 0
  int (*transmit)(struct network_context *nc, const uint8_t *buf, uint16_t size);       // return 0 if data was transmitted
  int (*stop)(struct network_context *nc);
  void (*info)(struct network_context *nc);                                             // print info
  int (*busy)(struct network_context *nc);                                              // returns != 0 if device is currently busy sending stuff
}_networkif;
 
 
 
void init_nic_registry();
void register_nic(struct networkif *nif, int SOURCE);
void init_all_nics();
void print_all_nics();
void process_nic_event_loop();
int stop_nic_by_type(int source);
int start_nic_by_type(int source);
int isready_by_type(int source);        // is this device ready to transmit (generally. it might still be busy)
int isonline_by_type(int source);       // is this device ready to transmit or expected to be able to transmit shortly?
void nic_set_transmit_status(struct network_context *nctx, int status);
int nic_is_busy(int source);            // calls nic->busy()
struct network_context *nic_by_type(int source);
struct network_context *nic_by_index(int index);
 
#endif