EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/emac_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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