MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/hal/emac_api.h@46:b156ef445742, 2017-06-03 (annotated)

Committer:
sahilmgandhi
Date:
Sat Jun 03 00:22:44 2017 +0000
Revision:
46:b156ef445742
Parent:
18:6a4db94011d3 
Final code for internal battlebot competition.

Who changed what in which revision?

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