NanostackPhy.h

00001 /*
00002  * Copyright (c) 2016, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef NANOSTACK_PHY_H_
00019 #define NANOSTACK_PHY_H_
00020 
00021 /** PHY driver class for Nanostack */
00022 class NanostackPhy {
00023 public:
00024 
00025     /** Register this physical interface with Nanostack
00026      *
00027      *  @return         Device driver ID or a negative error
00028      *                  code on failure
00029      */
00030     virtual int8_t phy_register() = 0;
00031 
00032     /** Read the mac address of this physical interface
00033      *
00034      * Note - some devices do not have a mac address
00035      *        in hardware.
00036      */
00037     virtual void get_mac_address(uint8_t *mac) = 0;
00038 
00039     /** Set the mac address of this physical interface
00040      *
00041      */
00042     virtual void set_mac_address(uint8_t *mac) = 0;
00043 
00044 protected:
00045     NanostackPhy() {}
00046     virtual ~NanostackPhy() {}
00047 };
00048 
00049 #endif /* NANOSTACK_INTERFACE_H_ */