Merge pull request #1961 from 0xc0170/spi_order_name

sg- · web-flow · commit a07a118410f4 · 2016-06-17T00:05:38.000+01:00
spi hal - specify default bit order
diff --git a/hal/hal/spi_api.h b/hal/hal/spi_api.h
@@ -81,7 +81,8 @@ void spi_free(spi_t *obj);
 
 /** Configure the SPI format
  *
- * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode
+ * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode.
+ * The default bit order is MSB.
  * @param[in,out] obj   The SPI object to configure
  * @param[in]     bits  The number of bits per frame
  * @param[in]     mode  The SPI mode (clock polarity, phase, and shift direction)

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,8 @@ void spi_free(spi_t *obj);`
`81`	`81`
`82`	`82`	`/** Configure the SPI format`
`83`	`83`	`*`
`84`		`- * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode`
	`84`	`+ * Set the number of bits per frame, configure clock polarity and phase, shift order and master/slave mode.`
	`85`	`+ * The default bit order is MSB.`
`85`	`86`	`* @param[in,out] obj The SPI object to configure`
`86`	`87`	`* @param[in] bits The number of bits per frame`
`87`	`88`	`* @param[in] mode The SPI mode (clock polarity, phase, and shift direction)`