Merge pull request #1486 from alignan/pull/cc2538-common

Unified cc2538 examples into single cc2538-common placeholder

examples/cc2538-common/Makefile

@@ -0,0 +1,8 @@
+DEFINES+=PROJECT_CONF_H=\"project-conf.h\"
+CONTIKI_PROJECT = test-pwm timer-test
+
+all: $(CONTIKI_PROJECT)
+
+CONTIKI = ../..
+CONTIKI_WITH_RIME = 1
+include $(CONTIKI)/Makefile.include

examples/cc2538-common/README.md

@@ -0,0 +1,18 @@
+README file for CC2538 common examples
+=========
+
+The `cc2538-commmon` groups examples common to all cc2538-based platforms.
+The examples in this folder are known to work on:
+
+* cc2538dk (default)
+* zoul
+
+To change the default target at compilation time you can add the following:
+
+make TARGET=zoul
+
+Or to define the default platform permanently:
+
+make TARGET=zoul savetarget
+
+This will create a `Makefile.target` file with the TARGET predefined.

examples/cc2538-common/crypto/cbc-mac-test.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-cbc-mac-test cc2538dk AES-CBC-MAC Test Project
+ * \defgroup cc2538-cbc-mac-test cc2538 AES-CBC-MAC Test Project
  *
- *   AES-CBC-MAC access example for CC2538 on SmartRF06EB.
+ *   AES-CBC-MAC access example for CC2538-based platforms
  *
  *   This example shows how AES-CBC-MAC should be used. The example also
  *   verifies the AES-CBC-MAC functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating AES-CBC-MAC on the cc2538dk platform
+ *     Example demonstrating AES-CBC-MAC
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/crypto/cbc-test.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-cbc-test cc2538dk AES-CBC Test Project
+ * \defgroup cc2538-cbc-test cc2538 AES-CBC Test Project
  *
- *   AES-CBC access example for CC2538 on SmartRF06EB.
+ *   AES-CBC access example for CC2538-based platforms
  *
  *   This example shows how AES-CBC should be used. The example also verifies
  *   the AES-CBC functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating AES-CBC on the cc2538dk platform
+ *     Example demonstrating AES-CBC
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/crypto/ccm-test.c

@@ -37,9 +37,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-ccm-test cc2538dk AES-CCM Test Project
+ * \defgroup cc2538-ccm-test cc2538 AES-CCM Test Project
  *
- *   AES-CCM access example for CC2538 on SmartRF06EB.
+ *   AES-CCM access example for CC2538-based platforms
  *
  *   This example shows how AES-CCM should be used. The example also verifies
  *   the AES-CCM functionality.
@@ -47,7 +47,7 @@
  * @{
  *
  * \file
- *     Example demonstrating AES-CCM on the cc2538dk platform
+ *     Example demonstrating AES-CCM
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/crypto/ctr-test.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-ctr-test cc2538dk AES-CTR Test Project
+ * \defgroup cc2538-ctr-test cc2538d AES-CTR Test Project
  *
- *   AES-CTR access example for CC2538 on SmartRF06EB.
+ *   AES-CTR access example for CC2538-based platforms
  *
  *   This example shows how AES-CTR should be used. The example also verifies
  *   the AES-CTR functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating AES-CTR on the cc2538dk platform
+ *     Example demonstrating AES-CTR
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/crypto/ecb-test.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-ecb-test cc2538dk AES-ECB Test Project
+ * \defgroup cc2538-ecb-test cc2538 AES-ECB Test Project
  *
- *   AES-ECB access example for CC2538 on SmartRF06EB.
+ *   AES-ECB access example for CC2538-based platforms
  *
  *   This example shows how AES-ECB should be used. The example also verifies
  *   the AES-ECB functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating AES-ECB on the cc2538dk platform
+ *     Example demonstrating AES-ECB
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/crypto/gcm-test.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-gcm-test cc2538dk AES-GCM Test Project
+ * \defgroup cc2538-gcm-test cc2538 AES-GCM Test Project
  *
- *   AES-GCM access example for CC2538 on SmartRF06EB.
+ *   AES-GCM access example for CC2538-based platforms
  *
  *   This example shows how AES-GCM should be used. The example also verifies
  *   the AES-GCM functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating AES-GCM on the cc2538dk platform
+ *     Example demonstrating AES-GCM
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/crypto/sha256-test.c

@@ -37,9 +37,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-sha256-test cc2538dk SHA-256 Test Project
+ * \defgroup cc2538-sha256-test cc2538 SHA-256 Test Project
  *
- *   SHA-256 access example for CC2538 on SmartRF06EB.
+ *   SHA-256 access example for CC2538-based platforms
  *
  *   This example shows how SHA-256 should be used. The example also verifies
  *   the SHA-256 functionality.
@@ -47,7 +47,7 @@
  * @{
  *
  * \file
- *     Example demonstrating SHA-256 on the cc2538dk platform
+ *     Example demonstrating SHA-256
  */
 #include "contiki.h"
 #include "sys/rtimer.h"

examples/cc2538-common/mqtt-demo/Makefile

@@ -6,5 +6,5 @@ CONTIKI_WITH_IPV6 = 1
 
 APPS += mqtt
 
-CONTIKI=../../..
+CONTIKI = ../../..
 include $(CONTIKI)/Makefile.include

examples/cc2538-common/mqtt-demo/mqtt-demo.c

@@ -31,14 +31,14 @@
 /** \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-mqtt-demo CC2538DK MQTT Demo Project
+ * \defgroup cc2538-mqtt-demo CC2538 MQTT Demo Project
  *
  * Demonstrates MQTT functionality. Works with IBM Quickstart as well as
  * mosquitto.
  * @{
  *
  * \file
- * An MQTT example for the cc2538dk platform
+ * An MQTT example for the cc2538-based platforms
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"

examples/cc2538-common/pka/ecc-ecdh.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-ecdh-test cc2538dk ECDH Test Project
+ * \defgroup cc2538-ecdh-test cc2538 ECDH Test Project
  *
- *   ECDH example for CC2538 on SmartRF06EB.
+ *   ECDH example for CC2538-based platforms
  *
  *   This example shows how ECDH should be used. The example also verifies
  *   the ECDH functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating ECDH on the cc2538dk platform
+ *     Example demonstrating ECDH
  */
 #include "contiki.h"
 #include "dev/ecc-algorithm.h"

examples/cc2538-common/pka/ecc-sign.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-ecdsa-sign-test cc2538dk ECDSA-Sign Test Project
+ * \defgroup cc2538-ecdsa-sign-test cc2538 ECDSA-Sign Test Project
  *
- *   ECDSA-Sign example for CC2538 on SmartRF06EB.
+ *   ECDSA-Sign example for CC2538-based platforms
  *
  *   This example shows how ECDSA-Sign should be used. The example also verifies
  *   the ECDSA-Sign functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating ECDSA-Sign on the cc2538dk platform
+ *     Example demonstrating ECDSA-Sign
  */
 #include "contiki.h"
 #include "dev/ecc-algorithm.h"

examples/cc2538-common/pka/ecc-verify.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-ecdsa-verify-test cc2538dk ECDSA-Verify Test Project
+ * \defgroup cc2538-ecdsa-verify-test cc2538 ECDSA-Verify Test Project
  *
- *   ECDSA-Verify example for CC2538 on SmartRF06EB.
+ *   ECDSA-Verify example for CC2538-based platforms
  *
  *   This example shows how ECDSA-Verify should be used. The example also verifies
  *   the ECDSA-Verify functionality.
@@ -42,7 +42,7 @@
  * @{
  *
  * \file
- *     Example demonstrating ECDSA-Verify on the cc2538dk platform
+ *     Example demonstrating ECDSA-Verify
  */
 #include "contiki.h"
 #include "dev/ecc-algorithm.h"

examples/cc2538-common/project-conf.h

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2012, Texas Instruments Incorporated - http://www.ti.com/
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/**
+ * \addtogroup cc2538-examples
+ * @{
+ *
+ * \file
+ * Project specific configuration defines for the basic cc2538dk examples
+ */
+#ifndef PROJECT_CONF_H_
+#define PROJECT_CONF_H_
+
+#define NETSTACK_CONF_RDC     nullrdc_driver
+
+#endif /* PROJECT_CONF_H_ */
+
+/** @} */

examples/cc2538-common/sniffer/Makefile.target

@@ -0,0 +1 @@
+TARGET = cc2538dk

examples/cc2538-common/sniffer/sniffer.c

@@ -32,9 +32,9 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-sniffer cc2538dk Sniffer
+ * \defgroup cc2538-sniffer cc2538 Sniffer
  *
- * Sniffer for the cc2538dk platform. Originally based on the sensinode
+ * Sniffer for the CC2538-based platforms. Originally based on the sensinode
  * and cc2530dk sniffers.
  *
  * This example is to be used combined with the sensniff host-side tool,

examples/cc2538-common/test-pwm.c

@@ -29,12 +29,12 @@
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \addtogroup remote-examples
+ * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup remote-test-pwm Test the CC2538 PWM driver
+ * \defgroup cc2538-test-pwm Test the CC2538 PWM driver
  *
- * Demonstrates the use of the CC2538 PWM driver for the Zolertia's Zoul boards
+ * Demonstrates the use of the CC2538 PWM driver
  *
  * @{
  *

examples/cc2538-common/timer-test.c

@@ -32,7 +32,7 @@
  * \addtogroup cc2538-examples
  * @{
  *
- * \defgroup cc2538-timers cc2538dk Timer Test Project
+ * \defgroup cc2538-timers cc2538 Timer Test Project
  *
  *    This example tests the correct functionality of clocks and timers.
  *

examples/cc2538dk/Makefile

@@ -1,5 +1,5 @@
 DEFINES+=PROJECT_CONF_H=\"project-conf.h\"
-CONTIKI_PROJECT = cc2538-demo timer-test
+CONTIKI_PROJECT = cc2538-demo
 
 all: $(CONTIKI_PROJECT)
 

examples/zolertia/zoul/Makefile

@@ -1,6 +1,6 @@
 DEFINES+=PROJECT_CONF_H=\"project-conf.h\"
 
-CONTIKI_PROJECT = zoul-demo test-tsl2563 test-sht25 test-pwm test-power-mgmt
+CONTIKI_PROJECT = zoul-demo test-tsl2563 test-sht25 test-power-mgmt
 CONTIKI_PROJECT += test-bmp085-bmp180 test-motion test-rotation-sensor
 CONTIKI_PROJECT += test-grove-light-sensor test-grove-loudness-sensor
 CONTIKI_PROJECT += test-weather-meter test-grove-gyro test-lcd

regression-tests/18-compile-arm-ports/Makefile

@@ -6,7 +6,7 @@ hello-world/ev-aducrf101mkxz \
 ipv6/rpl-border-router/ev-aducrf101mkxz \
 webserver-ipv6/ev-aducrf101mkxz \
 ipv6/multicast/ev-aducrf101mkxz \
-cc2538dk/sniffer/ev-aducrf101mkxz \
+cc2538-common/sniffer/ev-aducrf101mkxz \
 cc26xx/cc26xx-web-demo/srf06-cc26xx \
 cc26xx/very-sleepy-demo/srf06-cc26xx:BOARD=sensortag/cc2650 \
 cc26xx/cc26xx-web-demo/srf06-cc26xx:BOARD=sensortag/cc2650 \
@@ -19,17 +19,22 @@ ipso-objects/cc2538dk \
 webserver-ipv6/cc2538dk \
 cc2538dk/cc2538dk \
 cc2538dk/udp-ipv6-echo-server/cc2538dk \
-cc2538dk/sniffer/cc2538dk \
-cc2538dk/mqtt-demo/cc2538dk \
-cc2538dk/crypto/cc2538dk \
-cc2538dk/pka/cc2538dk \
 ipv6/multicast/cc2538dk \
+cc2538-common/cc2538dk \
+cc2538-common/sniffer/cc2538dk \
+cc2538-common/mqtt-demo/cc2538dk \
+cc2538-common/crypto/cc2538dk \
+cc2538-common/pka/cc2538dk \
+cc2538-common/zoul \
+cc2538-common/sniffer/zoul \
+cc2538-common/mqtt-demo/zoul \
+cc2538-common/crypto/zoul \
+cc2538-common/pka/zoul \
 zolertia/zoul/zoul \
 zolertia/zoul/cc1200-demo/zoul \
 er-rest-example/zoul \
 ipso-objects/zoul \
 hello-world/zoul \
-cc2538dk/mqtt-demo/zoul \
 er-rest-example/stm32nucleo-spirit1 \
 ipv6/rpl-border-router/stm32nucleo-spirit1 \
 ipv6/rpl-udp/stm32nucleo-spirit1 \