Subversion Repositories HelenOS

Rev

Rev 4307 | Rev 4505 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4307 Rev 4350
Line 29... Line 29...
29 
/** @addtogroup net
 29 
/** @addtogroup net
30 
 *  @{
 30 
 *  @{
31 
 */
 31 
 */
32 
 
 32 
 
33 
/** @file
 33 
/** @file
- 
 
 34 
 *  Networking module interface.
- 
 
 35 
 *  The same interface is used for standalone remote modules as well as for bundle modules.
- 
 
 36 
 *  The standalone remote modules have to be compiled with the net_remote.c source file.
- 
 
 37 
 *  The bundle networking module is compiled with the net_bundle.c source file and the choosen bundle module implementation source files.
34 
 */
 38 
 */
35 
 
 39 
 
36 
#ifndef __NET_NET_INTERFACE_H__
 40 
#ifndef __NET_NET_INTERFACE_H__
37 
#define __NET_NET_INTERFACE_H__
 41 
#define __NET_NET_INTERFACE_H__
38 
 
 42 
 
39 
//#include <async.h>
 - 
 
40 
 
 - 
 
41 
#include <ipc/services.h>
 43 
#include <ipc/services.h>
42 
 
 44 
 
43 
#include "../include/device.h"
 45 
#include "../include/device.h"
44 
 
 46 
 
45 
#include "../structures/measured_strings.h"
 47 
#include "../structures/measured_strings.h"
46 
 
 48 
 
- 
 
 49 
/** Returns the device specific configuration.
- 
 
 50 
 *  Returns the global configuration if the device specific is not found.
- 
 
 51 
 *  @param net_phone The networking module phone. Input parameter.
- 
 
 52 
 *  @param device_id The device identifier. Input parameter.
- 
 
 53 
 *  @param configuration The configuration and settings. Input/output parameter.
- 
 
 54 
 *  @param count The configuration entries count. Input parameter.
- 
 
 55 
 *  @param data The configuration and settings data. Input/output parameter.
- 
 
 56 
 *  @returns EOK on success.
- 
 
 57 
 *  @returns EINVAL if the configuration is NULL.
- 
 
 58 
 *  @returns EINVAL if the count is zero (0).
- 
 
 59 
 *  @returns Other error codes as defined for the generic_translate_req() function.
- 
 
 60 
 */
47 
int net_get_device_conf_req( int net_phone, device_id_t device_id, measured_string_ref * configuration, int count, char ** data );
 61 
int net_get_device_conf_req( int net_phone, device_id_t device_id, measured_string_ref * configuration, int count, char ** data );
- 
 
 62 
 
- 
 
 63 
/** Returns the global configuration.
- 
 
 64 
 *  @param net_phone The networking module phone. Input parameter.
- 
 
 65 
 *  @param configuration The configuration and settings. Input/output parameter.
- 
 
 66 
 *  @param count The configuration entries count. Input parameter.
- 
 
 67 
 *  @param data The configuration and settings data. Input/output parameter.
- 
 
 68 
 *  @returns EOK on success.
- 
 
 69 
 *  @returns EINVAL if the configuration is NULL.
- 
 
 70 
 *  @returns EINVAL if the count is zero (0).
- 
 
 71 
 *  @returns Other error codes as defined for the generic_translate_req() function.
- 
 
 72 
 */
48 
int net_get_conf_req( int net_phone, measured_string_ref * configuration, int count, char ** data );
 73 
int net_get_conf_req( int net_phone, measured_string_ref * configuration, int count, char ** data );
- 
 
 74 
 
- 
 
 75 
/** Frees the received settings.
- 
 
 76 
 *  @param settings The received settings. Input parameter.
- 
 
 77 
 *  @param data The received settings data. Input parameter.
- 
 
 78 
 *  @see net_get_device_conf_req()
- 
 
 79 
 *  @see net_get_conf_req()
- 
 
 80 
 */
49 
void    net_free_settings( measured_string_ref settings, char * data );
 81 
void    net_free_settings( measured_string_ref settings, char * data );
- 
 
 82 
 
- 
 
 83 
/** Connects to the networking module.
- 
 
 84 
 *  @param service The networking module service. Ignored parameter.
- 
 
 85 
 *  @returns The networking module phone on success.
- 
 
 86 
 *  @returns 0 if called by the bundle module.
- 
 
 87 
 */
50 
int net_connect_module( services_t service );
 88 
int net_connect_module( services_t service );
51 
 
 89 
 
52 
#endif
 90 
#endif
53 
 
 91 
 
54 
/** @}
 92 
/** @}