Rev 4743 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4743 | Rev 4756 | ||
---|---|---|---|
Line 71... | Line 71... | ||
71 | /** @name Message processing functions |
71 | /** @name Message processing functions |
72 | */ |
72 | */ |
73 | /*@{*/ |
73 | /*@{*/ |
74 | 74 | ||
75 | /** Processes IPC messages from the registered device driver modules in an infinite loop. |
75 | /** Processes IPC messages from the registered device driver modules in an infinite loop. |
76 | * @param iid The message identifier. Input parameter. |
76 | * @param[in] iid The message identifier. |
77 | * @param icall The message parameters. Input/output parameter. |
77 | * @param[in,out] icall The message parameters. |
78 | */ |
78 | */ |
79 | void nildummy_receiver( ipc_callid_t iid, ipc_call_t * icall ); |
79 | void nildummy_receiver( ipc_callid_t iid, ipc_call_t * icall ); |
80 | 80 | ||
81 | /** Registers new device or updates the MTU of an existing one. |
81 | /** Registers new device or updates the MTU of an existing one. |
82 | * Determines the device local hardware address. |
82 | * Determines the device local hardware address. |
83 | * @param device_id The new device identifier. Input parameter. |
83 | * @param[in] device_id The new device identifier. |
84 | * @param service The device driver service. Input parameter. |
84 | * @param[in] service The device driver service. |
85 | * @param mtu The device maximum transmission unit. Input parameter. |
85 | * @param[in] mtu The device maximum transmission unit. |
86 | * @returns EOK on success. |
86 | * @returns EOK on success. |
87 | * @returns EEXIST if the device with the different service exists. |
87 | * @returns EEXIST if the device with the different service exists. |
88 | * @returns ENOMEM if there is not enough memory left. |
88 | * @returns ENOMEM if there is not enough memory left. |
89 | * @returns Other error codes as defined for the netif_bind_service() function. |
89 | * @returns Other error codes as defined for the netif_bind_service() function. |
90 | * @returns Other error codes as defined for the netif_get_addr_req() function. |
90 | * @returns Other error codes as defined for the netif_get_addr_req() function. |
91 | */ |
91 | */ |
92 | int nildummy_device_message( device_id_t device_id, services_t service, size_t mtu ); |
92 | int nildummy_device_message( device_id_t device_id, services_t service, size_t mtu ); |
93 | 93 | ||
94 | /** Returns the device packet dimensions for sending. |
94 | /** Returns the device packet dimensions for sending. |
95 | * @param device_id The device identifier. Input parameter. |
95 | * @param[in] device_id The device identifier. |
96 | * @param addr_len The minimum reserved address length. Output parameter. |
96 | * @param[out] addr_len The minimum reserved address length. |
97 | * @param prefix The minimum reserved prefix size. Output parameter. |
97 | * @param[out] prefix The minimum reserved prefix size. |
98 | * @param content The maximum content size. Output parameter. |
98 | * @param[out] content The maximum content size. |
99 | * @param suffix The minimum reserved suffix size. Output parameter. |
99 | * @param[out] suffix The minimum reserved suffix size. |
100 | * @returns EOK on success. |
100 | * @returns EOK on success. |
101 | * @returns EBADMEM if either one of the parameters is NULL. |
101 | * @returns EBADMEM if either one of the parameters is NULL. |
102 | * @returns ENOENT if there is no such device. |
102 | * @returns ENOENT if there is no such device. |
103 | */ |
103 | */ |
104 | int nildummy_packet_space_message( device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix ); |
104 | int nildummy_packet_space_message( device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix ); |
105 | 105 | ||
106 | /** Registers receiving module service. |
106 | /** Registers receiving module service. |
107 | * Passes received packets for this service. |
107 | * Passes received packets for this service. |
108 | * @param service The module service. Input parameter. |
108 | * @param[in] service The module service. |
109 | * @param phone The service phone. Input parameter. |
109 | * @param[in] phone The service phone. |
110 | * @returns EOK on success. |
110 | * @returns EOK on success. |
111 | * @returns ENOENT if the service is not known. |
111 | * @returns ENOENT if the service is not known. |
112 | * @returns ENOMEM if there is not enough memory left. |
112 | * @returns ENOMEM if there is not enough memory left. |
113 | */ |
113 | */ |
114 | int nildummy_register_message( services_t service, int phone ); |
114 | int nildummy_register_message( services_t service, int phone ); |
115 | 115 | ||
116 | /** Sends the packet queue. |
116 | /** Sends the packet queue. |
117 | * @param device_id The device identifier. Input parameter. |
117 | * @param[in] device_id The device identifier. |
118 | * @param packet The packet queue. Input parameter. |
118 | * @param[in] packet The packet queue. |
119 | * @param sender The sending module service. Input parameter. |
119 | * @param[in] sender The sending module service. |
120 | * @returns EOK on success. |
120 | * @returns EOK on success. |
121 | * @returns ENOENT if there no such device. |
121 | * @returns ENOENT if there no such device. |
122 | * @returns EINVAL if the service parameter is not known. |
122 | * @returns EINVAL if the service parameter is not known. |
123 | */ |
123 | */ |
124 | int nildummy_send_message( device_id_t device_id, packet_t packet, services_t sender ); |
124 | int nildummy_send_message( device_id_t device_id, packet_t packet, services_t sender ); |
125 | 125 | ||
126 | /** Returns the device hardware address. |
126 | /** Returns the device hardware address. |
127 | * @param device_id The device identifier. Input parameter. |
127 | * @param[in] device_id The device identifier. |
128 | * @param address The device hardware address. Output parameter. |
128 | * @param[out] address The device hardware address. |
129 | * @returns EOK on success. |
129 | * @returns EOK on success. |
130 | * @returns EBADMEM if the address parameter is NULL. |
130 | * @returns EBADMEM if the address parameter is NULL. |
131 | * @returns ENOENT if there no such device. |
131 | * @returns ENOENT if there no such device. |
132 | */ |
132 | */ |
133 | int nildummy_addr_message( device_id_t device_id, measured_string_ref * address ); |
133 | int nildummy_addr_message( device_id_t device_id, measured_string_ref * address ); |