Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/srv/net/tl/icmp/icmp.h

    r849ed54 r4e5c7ba  
    2828
    2929/** @addtogroup icmp
    30  *  @{
     30 * @{
    3131 */
    3232
    3333/** @file
    34  *  ICMP module.
     34 * ICMP module.
    3535 */
    3636
    37 #ifndef __NET_ICMP_H__
    38 #define __NET_ICMP_H__
     37#ifndef NET_ICMP_H_
     38#define NET_ICMP_H_
    3939
    4040#include <fibril_synch.h>
    4141
    42 #include <icmp_codes.h>
     42#include <net/icmp_codes.h>
     43#include <net/packet.h>
    4344#include <adt/int_map.h>
    4445#include <icmp_header.h>
    4546
    4647/** Type definition of the ICMP reply data.
    47  *  @see icmp_reply
     48 * @see icmp_reply
    4849 */
    49 typedef struct icmp_reply       icmp_reply_t;
    50 
    51 /** Type definition of the ICMP reply data pointer.
    52  *  @see icmp_reply
    53  */
    54 typedef icmp_reply_t *  icmp_reply_ref;
     50typedef struct icmp_reply icmp_reply_t;
    5551
    5652/** Type definition of the ICMP global data.
    57  *  @see icmp_globals
     53 * @see icmp_globals
    5854 */
    59 typedef struct icmp_globals     icmp_globals_t;
     55typedef struct icmp_globals icmp_globals_t;
    6056
    6157/** Pending replies map.
    62  *  Maps message identifiers to the pending replies.
    63  *  Sending fibril waits for its associated reply event.
    64  *  Receiving fibril sets the associated reply with the return value and signals the event.
     58 *
     59 * Maps message identifiers to the pending replies.
     60 * Sending fibril waits for its associated reply event.
     61 * Receiving fibril sets the associated reply with the return value and signals
     62 * the event.
    6563 */
    6664INT_MAP_DECLARE(icmp_replies, icmp_reply_t);
    6765
    6866/** Echo specific data map.
    69  *  The bundle module gets an identifier of the assigned echo specific data while connecting.
    70  *  The identifier is used in the future semi-remote calls instead of the ICMP phone.
     67 *
     68 * The identifier is used in the future semi-remote calls instead of the ICMP
     69 * phone.
    7170 */
    7271INT_MAP_DECLARE(icmp_echo_data, icmp_echo_t);
    7372
    74 /** ICMP reply data.
    75  */
    76 struct icmp_reply{
    77         /** Reply result.
    78          */
     73/** ICMP reply data. */
     74struct icmp_reply {
     75        /** Reply result. */
    7976        int result;
    80         /** Safety lock.
    81          */
     77        /** Safety lock. */
    8278        fibril_mutex_t mutex;
    83         /** Received or timeouted reply signaling.
    84          */
     79        /** Received or timeouted reply signaling. */
    8580        fibril_condvar_t condvar;
    8681};
    8782
    88 /** ICMP global data.
    89  */
    90 struct  icmp_globals{
    91         /** IP module phone.
    92          */
     83/** ICMP global data. */
     84struct icmp_globals {
     85        /** IP module phone. */
    9386        int ip_phone;
    94         /** Packet dimension.
    95          */
     87        /** Packet dimension. */
    9688        packet_dimension_t packet_dimension;
    97         /** Networking module phone.
    98          */
     89        /** Networking module phone. */
    9990        int net_phone;
    100         /** Indicates whether ICMP error reporting is enabled.
    101          */
     91        /** Indicates whether ICMP error reporting is enabled. */
    10292        int error_reporting;
    103         /** Indicates whether ICMP echo replying (ping) is enabled.
    104          */
     93        /** Indicates whether ICMP echo replying (ping) is enabled. */
    10594        int echo_replying;
    106         /** The last used identifier number.
    107          */
     95        /** The last used identifier number. */
    10896        icmp_param_t last_used_id;
    109         /** The budled modules assigned echo specific data.
    110          */
     97        /** The budled modules assigned echo specific data. */
    11198        icmp_echo_data_t echo_data;
    112         /** Echo timeout locks.
    113          */
     99        /** Echo timeout locks. */
    114100        icmp_replies_t replies;
    115         /** Safety lock.
    116          */
     101        /** Safety lock. */
    117102        fibril_rwlock_t lock;
    118103};
    … …  
    122107/** @}
    123108 */
    124 
Note: See TracChangeset for help on using the changeset viewer.