zhang boie / mbed-dev-f30333

mbed-dev-f303

hal/emac_api.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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