Mistake on this page?
Report an issue in GitHub or email us
wiced_emac.h
1 /*
2  * Copyright (c) 2018 ARM Limited
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef WICED_EMAC_H_
19 #define WICED_EMAC_H_
20 
21 #include "EMAC.h"
22 #include "EMACInterface.h"
23 #include "WiFiInterface.h"
24 
25 #include "rtos/Mutex.h"
26 
27 class WICED_EMAC : public EMAC {
28 public:
29  WICED_EMAC();
30 
31  static WICED_EMAC &get_instance();
32 
33  /**
34  * Return maximum transmission unit
35  *
36  * @return MTU in bytes
37  */
38  virtual uint32_t get_mtu_size() const;
39 
40  /**
41  * Gets memory buffer alignment preference
42  *
43  * Gets preferred memory buffer alignment of the Emac device. IP stack may or may not
44  * align link out memory buffer chains using the alignment.
45  *
46  * @return Memory alignment requirement in bytes
47  */
48  virtual uint32_t get_align_preference() const;
49 
50  /**
51  * Return interface name
52  *
53  * @param name Pointer to where the name should be written
54  * @param size Maximum number of character to copy
55  */
56  virtual void get_ifname(char *name, uint8_t size) const;
57 
58  /**
59  * Returns size of the underlying interface HW address size.
60  *
61  * @return HW address size in bytes
62  */
63  virtual uint8_t get_hwaddr_size() const;
64 
65  /**
66  * Return interface-supplied HW address
67  *
68  * Copies HW address to provided memory, @param addr has to be of correct size see @a get_hwaddr_size
69  *
70  * HW address need not be provided if this interface does not have its own HW
71  * address configuration; stack will choose address from central system
72  * configuration if the function returns false and does not write to addr.
73  *
74  * @param addr HW address for underlying interface
75  * @return true if HW address is available
76  */
77  virtual bool get_hwaddr(uint8_t *addr) const;
78 
79  /**
80  * Set HW address for interface
81  *
82  * Provided address has to be of correct size, see @a get_hwaddr_size
83  *
84  * Called to set the MAC address to actually use - if @a get_hwaddr is provided
85  * the stack would normally use that, but it could be overridden, eg for test
86  * purposes.
87  *
88  * @param addr Address to be set
89  */
90  virtual void set_hwaddr(const uint8_t *addr);
91 
92  /**
93  * Sends the packet over the link
94  *
95  * That can not be called from an interrupt context.
96  *
97  * @param buf Packet to be send
98  * @return True if the packet was send successfully, False otherwise
99  */
100  virtual bool link_out(emac_mem_buf_t *buf);
101 
102  /**
103  * Initializes the HW
104  *
105  * @return True on success, False in case of an error.
106  */
107  virtual bool power_up();
108 
109  /**
110  * Deinitializes the HW
111  *
112  */
113  virtual void power_down();
114 
115  /**
116  * Sets a callback that needs to be called for packets received for that interface
117  *
118  * @param input_cb Function to be register as a callback
119  */
120  virtual void set_link_input_cb(emac_link_input_cb_t input_cb);
121 
122  /**
123  * Sets a callback that needs to be called on link status changes for given interface
124  *
125  * @param state_cb Function to be register as a callback
126  */
127  virtual void set_link_state_cb(emac_link_state_change_cb_t state_cb);
128 
129  /** Add device to a multicast group
130  *
131  * @param address A multicast group hardware address
132  */
133  virtual void add_multicast_group(const uint8_t *address);
134 
135  /** Remove device from a multicast group
136  *
137  * @param address A multicast group hardware address
138  */
139  virtual void remove_multicast_group(const uint8_t *address);
140 
141  /** Request reception of all multicast packets
142  *
143  * @param all True to receive all multicasts
144  * False to receive only multicasts addressed to specified groups
145  */
146  virtual void set_all_multicast(bool all);
147 
148  /** Sets memory manager that is used to handle memory buffers
149  *
150  * @param mem_mngr Pointer to memory manager
151  */
152  virtual void set_memory_manager(EMACMemoryManager &mem_mngr);
153 
154  emac_link_input_cb_t emac_link_input_cb; /**< Callback for incoming data */
155  emac_link_state_change_cb_t emac_link_state_cb;
156  EMACMemoryManager *memory_manager;
157 };
158 
159 #endif /* WICED_EMAC_H_ */
virtual uint32_t get_align_preference() const
Gets memory buffer alignment preference.
emac_link_input_cb_t emac_link_input_cb
Callback for incoming data.
Definition: wiced_emac.h:154
virtual void set_all_multicast(bool all)
Request reception of all multicast packets.
virtual void remove_multicast_group(const uint8_t *address)
Remove device from a multicast group.
virtual void power_down()
Deinitializes the HW.
virtual bool get_hwaddr(uint8_t *addr) const
Return interface-supplied HW address.
virtual bool power_up()
Initializes the HW.
virtual void get_ifname(char *name, uint8_t size) const
Return interface name.
mbed::Callback< void(emac_mem_buf_t *buf)> emac_link_input_cb_t
Callback to be register with EMAC interface and to be called for received packets.
Definition: EMAC.h:49
virtual void set_memory_manager(EMACMemoryManager &mem_mngr)
Sets memory manager that is used to handle memory buffers.
virtual uint8_t get_hwaddr_size() const
Returns size of the underlying interface HW address size.
virtual void add_multicast_group(const uint8_t *address)
Add device to a multicast group.
virtual uint32_t get_mtu_size() const
Return maximum transmission unit.
virtual void set_link_state_cb(emac_link_state_change_cb_t state_cb)
Sets a callback that needs to be called on link status changes for given interface.
This interface should be used to abstract low level access to networking hardware All operations rece...
Definition: EMAC.h:33
virtual void set_hwaddr(const uint8_t *addr)
Set HW address for interface.
virtual bool link_out(emac_mem_buf_t *buf)
Sends the packet over the link.
virtual void set_link_input_cb(emac_link_input_cb_t input_cb)
Sets a callback that needs to be called for packets received for that interface.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.