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