Preliminary main mbed library for nexpaq development

features/net/network-socket/EthInterface.h

Committer:
nexpaq
Date:
2016-11-04
Revision:
0:6c56fb4bc5f0

File content as of revision 0:6c56fb4bc5f0:

/* EthInterface
 * Copyright (c) 2015 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ETH_INTERFACE_H
#define ETH_INTERFACE_H

#include "network-socket/NetworkInterface.h"


/** EthInterface class
 *
 *  Common interface that is shared between ethernet hardware.
 */
class EthInterface : public NetworkInterface
{
public:
    /** Start the interface
     *
     *  @return     0 on success, negative error code on failure
     */
    virtual int connect() = 0;

    /** Stop the interface
     *
     *  @return     0 on success, negative error code on failure
     */
    virtual int disconnect() = 0;

    /** Get the local MAC address
     *
     *  @return         Null-terminated representation of the local MAC address
     */
    virtual const char *get_mac_address() = 0;
};


#endif