platform.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. // Platform-specific functions
  2. #ifndef __PLATFORM_H__
  3. #define __PLATFORM_H__
  4. #include "cpu_esp8266.h"
  5. #include "c_types.h"
  6. #include "driver/pwm.h"
  7. // Error / status codes
  8. enum
  9. {
  10. PLATFORM_ERR,
  11. PLATFORM_OK,
  12. PLATFORM_UNDERFLOW = -1
  13. };
  14. // Platform initialization
  15. int platform_init(void);
  16. void platform_int_init(void);
  17. // ****************************************************************************
  18. // KEY_LED functions
  19. uint8_t platform_key_led( uint8_t level);
  20. // *****************************************************************************
  21. // GPIO subsection
  22. #define PLATFORM_GPIO_FLOAT 0
  23. #define PLATFORM_GPIO_PULLUP 1
  24. #define PLATFORM_GPIO_INT 2
  25. #define PLATFORM_GPIO_OUTPUT 1
  26. #define PLATFORM_GPIO_INPUT 0
  27. #define PLATFORM_GPIO_HIGH 1
  28. #define PLATFORM_GPIO_LOW 0
  29. /* GPIO interrupt handler */
  30. typedef void (* platform_gpio_intr_handler_fn_t)( unsigned pin, unsigned level );
  31. int platform_gpio_mode( unsigned pin, unsigned mode, unsigned pull );
  32. int platform_gpio_write( unsigned pin, unsigned level );
  33. int platform_gpio_read( unsigned pin );
  34. void platform_gpio_init( platform_gpio_intr_handler_fn_t cb );
  35. int platform_gpio_intr_init( unsigned pin, GPIO_INT_TYPE type );
  36. // *****************************************************************************
  37. // Timer subsection
  38. // Timer data type
  39. typedef uint32_t timer_data_type;
  40. // *****************************************************************************
  41. // CAN subsection
  42. // Maximum length for any CAN message
  43. #define PLATFORM_CAN_MAXLEN 8
  44. // eLua CAN ID types
  45. enum
  46. {
  47. ELUA_CAN_ID_STD = 0,
  48. ELUA_CAN_ID_EXT
  49. };
  50. int platform_can_exists( unsigned id );
  51. uint32_t platform_can_setup( unsigned id, uint32_t clock );
  52. int platform_can_send( unsigned id, uint32_t canid, uint8_t idtype, uint8_t len, const uint8_t *data );
  53. int platform_can_recv( unsigned id, uint32_t *canid, uint8_t *idtype, uint8_t *len, uint8_t *data );
  54. // *****************************************************************************
  55. // SPI subsection
  56. // There are 4 "virtual" SPI ports (SPI0...SPI3).
  57. #define PLATFORM_SPI_TOTAL 4
  58. // TODO: PLATFORM_SPI_TOTAL is not used - figure out purpose, or remove?
  59. // SPI mode
  60. #define PLATFORM_SPI_MASTER 1
  61. #define PLATFORM_SPI_SLAVE 0
  62. // SS values
  63. #define PLATFORM_SPI_SELECT_ON 1
  64. #define PLATFORM_SPI_SELECT_OFF 0
  65. // SPI enable/disable
  66. #define PLATFORM_SPI_ENABLE 1
  67. #define PLATFORM_SPI_DISABLE 0
  68. // SPI clock phase
  69. #define PLATFORM_SPI_CPHA_LOW 0
  70. #define PLATFORM_SPI_CPHA_HIGH 1
  71. // SPI clock polarity
  72. #define PLATFORM_SPI_CPOL_LOW 0
  73. #define PLATFORM_SPI_CPOL_HIGH 1
  74. // Data types
  75. typedef uint32_t spi_data_type;
  76. // The platform SPI functions
  77. int platform_spi_exists( unsigned id );
  78. uint32_t platform_spi_setup( uint8_t id, int mode, unsigned cpol, unsigned cpha, uint32_t clock_div);
  79. int platform_spi_send( uint8_t id, uint8_t bitlen, spi_data_type data );
  80. spi_data_type platform_spi_send_recv( uint8_t id, uint8_t bitlen, spi_data_type data );
  81. void platform_spi_select( unsigned id, int is_select );
  82. int platform_spi_set_mosi( uint8_t id, uint8_t offset, uint8_t bitlen, spi_data_type data );
  83. spi_data_type platform_spi_get_miso( uint8_t id, uint8_t offset, uint8_t bitlen );
  84. int platform_spi_transaction( uint8_t id, uint8_t cmd_bitlen, spi_data_type cmd_data,
  85. uint8_t addr_bitlen, spi_data_type addr_data,
  86. uint16_t mosi_bitlen, uint8_t dummy_bitlen, int16_t miso_bitlen );
  87. // *****************************************************************************
  88. // UART subsection
  89. // There are 3 "virtual" UART ports (UART0...UART2).
  90. #define PLATFORM_UART_TOTAL 3
  91. // TODO: PLATFORM_UART_TOTAL is not used - figure out purpose, or remove?
  92. // Note: Some CPUs (e.g. LM4F/TM4C) have more than 3 hardware UARTs
  93. // Parity
  94. enum
  95. {
  96. PLATFORM_UART_PARITY_NONE = 0,
  97. PLATFORM_UART_PARITY_EVEN = 1,
  98. PLATFORM_UART_PARITY_ODD = 2,
  99. PLATFORM_UART_PARITY_MARK = 3,
  100. PLATFORM_UART_PARITY_SPACE = 4
  101. };
  102. // Stop bits
  103. enum
  104. {
  105. PLATFORM_UART_STOPBITS_1 = 1,
  106. PLATFORM_UART_STOPBITS_2 = 2,
  107. PLATFORM_UART_STOPBITS_1_5 = 3
  108. };
  109. // Flow control types (this is a bit mask, one can specify PLATFORM_UART_FLOW_RTS | PLATFORM_UART_FLOW_CTS )
  110. #define PLATFORM_UART_FLOW_NONE 0
  111. #define PLATFORM_UART_FLOW_RTS 1
  112. #define PLATFORM_UART_FLOW_CTS 2
  113. // The platform UART functions
  114. int platform_uart_exists( unsigned id );
  115. uint32_t platform_uart_setup( unsigned id, uint32_t baud, int databits, int parity, int stopbits );
  116. int platform_uart_set_buffer( unsigned id, unsigned size );
  117. void platform_uart_send( unsigned id, uint8_t data );
  118. void platform_s_uart_send( unsigned id, uint8_t data );
  119. int platform_uart_recv( unsigned id, unsigned timer_id, timer_data_type timeout );
  120. int platform_s_uart_recv( unsigned id, timer_data_type timeout );
  121. int platform_uart_set_flow_control( unsigned id, int type );
  122. int platform_s_uart_set_flow_control( unsigned id, int type );
  123. void platform_uart_alt( int set );
  124. // *****************************************************************************
  125. // PWM subsection
  126. // There are 16 "virtual" PWM channels (PWM0...PWM15)
  127. #define PLATFORM_PWM_TOTAL 16
  128. // TODO: PLATFORM_PWM_TOTAL is not used - figure out purpose, or remove?
  129. #define NORMAL_PWM_DEPTH PWM_DEPTH
  130. #define NORMAL_DUTY(d) (((unsigned)(d)*NORMAL_PWM_DEPTH) / PWM_DEPTH)
  131. #define DUTY(d) ((uint16_t)( ((unsigned)(d)*PWM_DEPTH) / NORMAL_PWM_DEPTH) )
  132. // The platform PWM functions
  133. int platform_pwm_exists( unsigned id );
  134. uint32_t platform_pwm_setup( unsigned id, uint32_t frequency, unsigned duty );
  135. void platform_pwm_close( unsigned id );
  136. void platform_pwm_start( unsigned id );
  137. void platform_pwm_stop( unsigned id );
  138. uint32_t platform_pwm_set_clock( unsigned id, uint32_t data );
  139. uint32_t platform_pwm_get_clock( unsigned id );
  140. uint32_t platform_pwm_set_duty( unsigned id, uint32_t data );
  141. uint32_t platform_pwm_get_duty( unsigned id );
  142. // *****************************************************************************
  143. // The platform ADC functions
  144. // Functions requiring platform-specific implementation
  145. int platform_adc_update_sequence(void);
  146. int platform_adc_start_sequence(void);
  147. void platform_adc_stop( unsigned id );
  148. uint32_t platform_adc_set_clock( unsigned id, uint32_t frequency);
  149. int platform_adc_check_timer_id( unsigned id, unsigned timer_id );
  150. // ADC Common Functions
  151. int platform_adc_exists( unsigned id );
  152. uint32_t platform_adc_get_maxval( unsigned id );
  153. uint32_t platform_adc_set_smoothing( unsigned id, uint32_t length );
  154. void platform_adc_set_blocking( unsigned id, uint32_t mode );
  155. void platform_adc_set_freerunning( unsigned id, uint32_t mode );
  156. uint32_t platform_adc_is_done( unsigned id );
  157. void platform_adc_set_timer( unsigned id, uint32_t timer );
  158. // *****************************************************************************
  159. // I2C platform interface
  160. // I2C speed
  161. enum
  162. {
  163. PLATFORM_I2C_SPEED_SLOW = 100000,
  164. PLATFORM_I2C_SPEED_FAST = 400000
  165. };
  166. // I2C direction
  167. enum
  168. {
  169. PLATFORM_I2C_DIRECTION_TRANSMITTER,
  170. PLATFORM_I2C_DIRECTION_RECEIVER
  171. };
  172. int platform_i2c_exists( unsigned id );
  173. uint32_t platform_i2c_setup( unsigned id, uint8_t sda, uint8_t scl, uint32_t speed );
  174. void platform_i2c_send_start( unsigned id );
  175. void platform_i2c_send_stop( unsigned id );
  176. int platform_i2c_send_address( unsigned id, uint16_t address, int direction );
  177. int platform_i2c_send_byte( unsigned id, uint8_t data );
  178. int platform_i2c_recv_byte( unsigned id, int ack );
  179. // *****************************************************************************
  180. // Ethernet specific functions
  181. void platform_eth_send_packet( const void* src, uint32_t size );
  182. uint32_t platform_eth_get_packet_nb( void* buf, uint32_t maxlen );
  183. void platform_eth_force_interrupt(void);
  184. uint32_t platform_eth_get_elapsed_time(void);
  185. // *****************************************************************************
  186. // Internal flash erase/write functions
  187. uint32_t platform_flash_get_first_free_block_address( uint32_t *psect );
  188. uint32_t platform_flash_get_sector_of_address( uint32_t addr );
  189. uint32_t platform_flash_write( const void *from, uint32_t toaddr, uint32_t size );
  190. uint32_t platform_flash_read( void *to, uint32_t fromaddr, uint32_t size );
  191. uint32_t platform_s_flash_write( const void *from, uint32_t toaddr, uint32_t size );
  192. uint32_t platform_s_flash_read( void *to, uint32_t fromaddr, uint32_t size );
  193. uint32_t platform_flash_get_num_sectors(void);
  194. int platform_flash_erase_sector( uint32_t sector_id );
  195. /**
  196. * Translated a mapped address to a physical flash address, based on the
  197. * current flash cache mapping.
  198. * @param mapped_addr Address to translate (>= INTERNAL_FLASH_MAPPED_ADDRESS)
  199. * @return the corresponding physical flash address, or -1 if flash cache is
  200. * not currently active.
  201. * @see Cache_Read_Enable.
  202. */
  203. uint32_t platform_flash_mapped2phys (uint32_t mapped_addr);
  204. // *****************************************************************************
  205. // Allocator support
  206. void* platform_get_first_free_ram( unsigned id );
  207. void* platform_get_last_free_ram( unsigned id );
  208. // *****************************************************************************
  209. // Other glue
  210. int platform_ow_exists( unsigned id );
  211. int platform_gpio_exists( unsigned id );
  212. // *****************************************************************************
  213. // Helper macros
  214. #define MOD_CHECK_ID( mod, id )\
  215. if( !platform_ ## mod ## _exists( id ) )\
  216. return luaL_error( L, #mod" %d does not exist", ( unsigned )id )
  217. #define MOD_CHECK_TIMER( id )\
  218. if( id == PLATFORM_TIMER_SYS_ID && !platform_timer_sys_available() )\
  219. return luaL_error( L, "the system timer is not available on this platform" );\
  220. if( !platform_timer_exists( id ) )\
  221. return luaL_error( L, "timer %d does not exist", ( unsigned )id )\
  222. #define MOD_CHECK_RES_ID( mod, id, resmod, resid )\
  223. if( !platform_ ## mod ## _check_ ## resmod ## _id( id, resid ) )\
  224. return luaL_error( L, #resmod" %d not valid with " #mod " %d", ( unsigned )resid, ( unsigned )id )
  225. #endif