Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/hal/emac_api.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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