vmod/driver/modulbus_register.h

   1 #ifndef _CARRIER_H_
   2 #define _CARRIER_H_
   3
   4 /**
   5  *  @brief definition of an address space as provided by the
   6  *         carrier driver
   7  */
   8 struct carrier_as {
   9         unsigned long   address;
  10         int             width;
  11         int             size;
  12         int             is_big_endian;
  13 };
  14
  15
  16 /* @brief type of a mezzanine isr */
  17 typedef int (*isrcb_t)(
  18         void *device_id,
  19         void* extra);
  20
  21 /* @brief type of a get_address_space entry point */
  22 typedef int (*gas_t)(
  23         struct carrier_as *as,
  24         int board_number,
  25         int board_position,
  26         int address_space_number);
  27
  28 /* @brief type of a register_isr entry point */
  29 typedef int (*risr_t)(
  30         isrcb_t callback,
  31         void *dev,
  32         int board_number,
  33         int board_position);
  34
  35
  36
  37 /** @brief register a carrier's entry points in the carrier
  38  *  register module
  39  *  @param carrier_type         official name of the driver
  40  *  @param get_address_space    its gas_t entry point
  41  *  @param register_isr         its risr_t entry point
  42  *
  43  *  @return 0 on success
  44  *  @return <0 on failure
  45  */
  46 int modulbus_carrier_register(
  47         char   *carrier_type,
  48         gas_t   get_address_space,
  49         risr_t  register_isr);
  50
  51 /** @brief unregister a carrier from the entry point list
  52  *
  53  * @param       name    official name of the driver
  54  *
  55  * @return      0 on success
  56  * @return <0 on failure
  57  */
  58
  59 int modulbus_carrier_unregister(char *name);
  60
  61 /** @brief get a carrier's entry point for getting address spaces
  62  *  @param - official name of the carrier driver
  63  *
  64  *  @return - a valid pointer to the entry point
  65  *  @return - NULL on failure
  66  */
  67 gas_t   modulbus_carrier_as_entry(char *carrier);
  68
  69 /** @brief get a carrier's entry point for registering ISR callbacks
  70  *  @param - official name of the carrier driver
  71  *
  72  *  @return - a valid pointer to the entry point
  73  *  @return - NULL on failure
  74  */
  75 risr_t  modulbus_carrier_isr_entry(char *carrier);
  76
  77 #endif /*_CARRIER_H_ */