Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

hal/emac_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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