Marco Mayer / Mbed OS Queue

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/hal/emac_api.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /* mbed Microcontroller Library
demayer 0:6bf0743ece18 2 * Copyright (c) 2016 ARM Limited
demayer 0:6bf0743ece18 3 *
demayer 0:6bf0743ece18 4 * Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 5 * you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 6 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 7 *
demayer 0:6bf0743ece18 8 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 9 *
demayer 0:6bf0743ece18 10 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 11 * distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 13 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 14 * limitations under the License.
demayer 0:6bf0743ece18 15 */
demayer 0:6bf0743ece18 16
demayer 0:6bf0743ece18 17 #ifndef MBED_EMAC_API_H
demayer 0:6bf0743ece18 18 #define MBED_EMAC_API_H
demayer 0:6bf0743ece18 19
demayer 0:6bf0743ece18 20 #if DEVICE_EMAC
demayer 0:6bf0743ece18 21
demayer 0:6bf0743ece18 22 #include <stdbool.h>
demayer 0:6bf0743ece18 23 #include "emac_stack_mem.h"
demayer 0:6bf0743ece18 24
demayer 0:6bf0743ece18 25 typedef struct emac_interface emac_interface_t;
demayer 0:6bf0743ece18 26
demayer 0:6bf0743ece18 27 /**
demayer 0:6bf0743ece18 28 * EmacInterface
demayer 0:6bf0743ece18 29 *
demayer 0:6bf0743ece18 30 * This interface should be used to abstract low level access to networking hardware
demayer 0:6bf0743ece18 31 */
demayer 0:6bf0743ece18 32
demayer 0:6bf0743ece18 33 /**
demayer 0:6bf0743ece18 34 * Callback to be register with Emac interface and to be called fore received packets
demayer 0:6bf0743ece18 35 *
demayer 0:6bf0743ece18 36 * @param data Arbitrary user data (IP stack)
demayer 0:6bf0743ece18 37 * @param buf Received data
demayer 0:6bf0743ece18 38 */
demayer 0:6bf0743ece18 39 typedef void (*emac_link_input_fn)(void *data, emac_stack_mem_chain_t *buf);
demayer 0:6bf0743ece18 40
demayer 0:6bf0743ece18 41 /**
demayer 0:6bf0743ece18 42 * Callback to be register with Emac interface and to be called for link status changes
demayer 0:6bf0743ece18 43 *
demayer 0:6bf0743ece18 44 * @param data Arbitrary user data (IP stack)
demayer 0:6bf0743ece18 45 * @param up Link status
demayer 0:6bf0743ece18 46 */
demayer 0:6bf0743ece18 47 typedef void (*emac_link_state_change_fn)(void *data, bool up);
demayer 0:6bf0743ece18 48
demayer 0:6bf0743ece18 49 /**
demayer 0:6bf0743ece18 50 * Return maximum transmission unit
demayer 0:6bf0743ece18 51 *
demayer 0:6bf0743ece18 52 * @param emac Emac interface
demayer 0:6bf0743ece18 53 * @return MTU in bytes
demayer 0:6bf0743ece18 54 */
demayer 0:6bf0743ece18 55 typedef uint32_t (*emac_get_mtu_size_fn)(emac_interface_t *emac);
demayer 0:6bf0743ece18 56
demayer 0:6bf0743ece18 57 /**
demayer 0:6bf0743ece18 58 * Return interface name
demayer 0:6bf0743ece18 59 *
demayer 0:6bf0743ece18 60 * @param emac Emac interface
demayer 0:6bf0743ece18 61 * @param name Pointer to where the name should be written
demayer 0:6bf0743ece18 62 * @param size Maximum number of character to copy
demayer 0:6bf0743ece18 63 */
demayer 0:6bf0743ece18 64 typedef void (*emac_get_ifname_fn)(emac_interface_t *emac, char *name, uint8_t size);
demayer 0:6bf0743ece18 65
demayer 0:6bf0743ece18 66 /**
demayer 0:6bf0743ece18 67 * Returns size of the underlying interface HW address size
demayer 0:6bf0743ece18 68 *
demayer 0:6bf0743ece18 69 * @param emac Emac interface
demayer 0:6bf0743ece18 70 * @return HW address size in bytes
demayer 0:6bf0743ece18 71 */
demayer 0:6bf0743ece18 72 typedef uint8_t (*emac_get_hwaddr_size_fn)(emac_interface_t *emac);
demayer 0:6bf0743ece18 73
demayer 0:6bf0743ece18 74 /**
demayer 0:6bf0743ece18 75 * Return interface hw address
demayer 0:6bf0743ece18 76 *
demayer 0:6bf0743ece18 77 * Copies HW address to provided memory, @param addr has to be of correct size see @a get_hwaddr_size
demayer 0:6bf0743ece18 78 *
demayer 0:6bf0743ece18 79 * @param emac Emac interface
demayer 0:6bf0743ece18 80 * @param addr HW address for underlying interface
demayer 0:6bf0743ece18 81 */
demayer 0:6bf0743ece18 82 typedef void (*emac_get_hwaddr_fn)(emac_interface_t *emac, uint8_t *addr);
demayer 0:6bf0743ece18 83
demayer 0:6bf0743ece18 84 /**
demayer 0:6bf0743ece18 85 * Set HW address for interface
demayer 0:6bf0743ece18 86 *
demayer 0:6bf0743ece18 87 * Provided address has to be of correct size, see @a get_hwaddr_size
demayer 0:6bf0743ece18 88 *
demayer 0:6bf0743ece18 89 * @param emac Emac interface
demayer 0:6bf0743ece18 90 * @param addr Address to be set
demayer 0:6bf0743ece18 91 */
demayer 0:6bf0743ece18 92 typedef void (*emac_set_hwaddr_fn)(emac_interface_t *emac, uint8_t *addr);
demayer 0:6bf0743ece18 93
demayer 0:6bf0743ece18 94 /**
demayer 0:6bf0743ece18 95 * Sends the packet over the link
demayer 0:6bf0743ece18 96 *
demayer 0:6bf0743ece18 97 * That can not be called from an interrupt context.
demayer 0:6bf0743ece18 98 *
demayer 0:6bf0743ece18 99 * @param emac Emac interface
demayer 0:6bf0743ece18 100 * @param buf Packet to be send
demayer 0:6bf0743ece18 101 * @return True if the packet was send successfully, False otherwise
demayer 0:6bf0743ece18 102 */
demayer 0:6bf0743ece18 103 typedef bool (*emac_link_out_fn)(emac_interface_t *emac, emac_stack_mem_t *buf);
demayer 0:6bf0743ece18 104
demayer 0:6bf0743ece18 105 /**
demayer 0:6bf0743ece18 106 * Initializes the HW
demayer 0:6bf0743ece18 107 *
demayer 0:6bf0743ece18 108 * @return True on success, False in case of an error.
demayer 0:6bf0743ece18 109 */
demayer 0:6bf0743ece18 110 typedef bool (*emac_power_up_fn)(emac_interface_t *emac);
demayer 0:6bf0743ece18 111
demayer 0:6bf0743ece18 112 /**
demayer 0:6bf0743ece18 113 * Deinitializes the HW
demayer 0:6bf0743ece18 114 *
demayer 0:6bf0743ece18 115 * @param emac Emac interface
demayer 0:6bf0743ece18 116 */
demayer 0:6bf0743ece18 117 typedef void (*emac_power_down_fn)(emac_interface_t *emac);
demayer 0:6bf0743ece18 118
demayer 0:6bf0743ece18 119 /**
demayer 0:6bf0743ece18 120 * Sets a callback that needs to be called for packets received for that interface
demayer 0:6bf0743ece18 121 *
demayer 0:6bf0743ece18 122 * @param emac Emac interface
demayer 0:6bf0743ece18 123 * @param input_cb Function to be register as a callback
demayer 0:6bf0743ece18 124 * @param data Arbitrary user data to be passed to the callback
demayer 0:6bf0743ece18 125 */
demayer 0:6bf0743ece18 126 typedef void (*emac_set_link_input_cb_fn)(emac_interface_t *emac, emac_link_input_fn input_cb, void *data);
demayer 0:6bf0743ece18 127
demayer 0:6bf0743ece18 128 /**
demayer 0:6bf0743ece18 129 * Sets a callback that needs to be called on link status changes for given interface
demayer 0:6bf0743ece18 130 *
demayer 0:6bf0743ece18 131 * @param emac Emac interface
demayer 0:6bf0743ece18 132 * @param state_cb Function to be register as a callback
demayer 0:6bf0743ece18 133 * @param data Arbitrary user data to be passed to the callback
demayer 0:6bf0743ece18 134 */
demayer 0:6bf0743ece18 135 typedef void (*emac_set_link_state_cb_fn)(emac_interface_t *emac, emac_link_state_change_fn state_cb, void *data);
demayer 0:6bf0743ece18 136
demayer 0:6bf0743ece18 137 typedef struct emac_interface_ops {
demayer 0:6bf0743ece18 138 emac_get_mtu_size_fn get_mtu_size;
demayer 0:6bf0743ece18 139 emac_get_ifname_fn get_ifname;
demayer 0:6bf0743ece18 140 emac_get_hwaddr_size_fn get_hwaddr_size;
demayer 0:6bf0743ece18 141 emac_get_hwaddr_fn get_hwaddr;
demayer 0:6bf0743ece18 142 emac_set_hwaddr_fn set_hwaddr;
demayer 0:6bf0743ece18 143 emac_link_out_fn link_out;
demayer 0:6bf0743ece18 144 emac_power_up_fn power_up;
demayer 0:6bf0743ece18 145 emac_power_down_fn power_down;
demayer 0:6bf0743ece18 146 emac_set_link_input_cb_fn set_link_input_cb;
demayer 0:6bf0743ece18 147 emac_set_link_state_cb_fn set_link_state_cb;
demayer 0:6bf0743ece18 148 } emac_interface_ops_t;
demayer 0:6bf0743ece18 149
demayer 0:6bf0743ece18 150 typedef struct emac_interface {
demayer 0:6bf0743ece18 151 const emac_interface_ops_t ops;
demayer 0:6bf0743ece18 152 void *hw;
demayer 0:6bf0743ece18 153 } emac_interface_t;
demayer 0:6bf0743ece18 154
demayer 0:6bf0743ece18 155 #else
demayer 0:6bf0743ece18 156
demayer 0:6bf0743ece18 157 typedef void *emac_interface_t;
demayer 0:6bf0743ece18 158
demayer 0:6bf0743ece18 159 #endif /* DEVICE_EMAC */
demayer 0:6bf0743ece18 160 #endif /* MBED_EMAC_API_H */