NanostackMACPhy.h

00001 /*
00002  * Copyright (c) 2019, 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_MACPHY_H_
00019 #define NANOSTACK_MACPHY_H_
00020 
00021 #include "NanostackPhy.h"
00022 
00023 /** MAC PHY driver class for Nanostack */
00024 class NanostackMACPhy : public NanostackPhy {
00025 public:
00026     /** Read the mac address of this physical interface
00027      *
00028      *  Note - some devices do not have a mac address
00029      *         in hardware.
00030      *
00031      *  @param mac      mac address
00032      */
00033     virtual void get_mac_address(uint8_t *mac) = 0;
00034 
00035     /** Set the mac address of this physical interface
00036      *
00037      *  @param mac      mac address
00038      */
00039     virtual void set_mac_address(uint8_t *mac) = 0;
00040 
00041     /** Provide access to the NanostackMACPhy
00042      *
00043      *  @return          NanostackMACPhy
00044      */
00045     virtual NanostackMACPhy *nanostack_mac_phy()
00046     {
00047         return this;
00048     }
00049 };
00050 
00051 #endif /* NANOSTACK_MACPHY_H_ */