Remove extern variable declarations in the HAL header file

[pes-rpp/rpp-lib.git] / rpp / include / hal / port_spi.h

diff --git a/rpp/include/hal/port_spi.h b/rpp/include/hal/port_spi.h
index ac5df3f0e72ff2d69f67e1679bf7daa4b9c599c0..f08c4e1491f2e34ea73a029fb04f13f4ec51d67f 100644 (file)
--- a/rpp/include/hal/port_spi.h
+++ b/rpp/include/hal/port_spi.h
@@ -1,17 +1,26 @@
-/*
- * port_spi.h
+/**
  *
- *  Created on: 26.11.2012
- *      Author: Michal Horn
+ * @file port_spi.h
+ *
+ * @copyright Copyright (C) 2012-2013 Czech Technical University in Prague
+ *
+ * @author Michal Horn <hornmich@fel.cvut.cz>
  */
 
 #ifndef PORT_SPI_H_
 #define PORT_SPI_H_
 
 //#include "sys_common.h"
-#include "sys/sys.h"
+#include "hal/hal.h"
 
-uint32_t hal_spi_port_transfer_command(uint32_t* config, uint32_t num_bytes, const uint32_t* commands);
+/**
+ * Transfer command through the spi
+ * @param[in] config    Address of the SPI
+ * @param[in] num_bytes Number of bytes to be trasfered
+ * @param[in] commands  SPI command to be sent
+ * @return spi response
+ */
+uint32_t hal_spi_port_transfer_command(uint32_t *config, uint32_t num_bytes, const uint32_t *commands);
 
 
 #endif /* PORT_SPI_H_ */