BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

mbed-os/hal/emac_api.h@2:798925c9e4a8, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:55:34 2018 +0000
Revision:
2:798925c9e4a8
Parent:
1:9c5af431a1f1 
bluetooth

Who changed what in which revision?

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